summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/OutputStream.Rd
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/r/man/OutputStream.Rd
parentInitial commit. (diff)
downloadceph-b26c4052f3542036551aa9dec9caa4226e456195.tar.xz
ceph-b26c4052f3542036551aa9dec9caa4226e456195.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/arrow/r/man/OutputStream.Rd')
-rw-r--r--src/arrow/r/man/OutputStream.Rd38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/arrow/r/man/OutputStream.Rd b/src/arrow/r/man/OutputStream.Rd
new file mode 100644
index 000000000..f7c71b192
--- /dev/null
+++ b/src/arrow/r/man/OutputStream.Rd
@@ -0,0 +1,38 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/io.R
+\docType{class}
+\name{OutputStream}
+\alias{OutputStream}
+\alias{FileOutputStream}
+\alias{BufferOutputStream}
+\title{OutputStream classes}
+\description{
+\code{FileOutputStream} is for writing to a file;
+\code{BufferOutputStream} writes to a buffer;
+You can create one and pass it to any of the table writers, for example.
+}
+\section{Factory}{
+
+
+The \verb{$create()} factory methods instantiate the \code{OutputStream} object and
+take the following arguments, depending on the subclass:
+\itemize{
+\item \code{path} For \code{FileOutputStream}, a character file name
+\item \code{initial_capacity} For \code{BufferOutputStream}, the size in bytes of the
+buffer.
+}
+}
+
+\section{Methods}{
+
+\itemize{
+\item \verb{$tell()}: return the position in the stream
+\item \verb{$close()}: close the stream
+\item \verb{$write(x)}: send \code{x} to the stream
+\item \verb{$capacity()}: for \code{BufferOutputStream}
+\item \verb{$finish()}: for \code{BufferOutputStream}
+\item \verb{$GetExtentBytesWritten()}: for \code{MockOutputStream}, report how many bytes
+were sent.
+}
+}
+