summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/compression.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/compression.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/compression.Rd')
-rw-r--r--src/arrow/r/man/compression.Rd31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/arrow/r/man/compression.Rd b/src/arrow/r/man/compression.Rd
new file mode 100644
index 000000000..7cdb320d6
--- /dev/null
+++ b/src/arrow/r/man/compression.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/compression.R
+\docType{class}
+\name{compression}
+\alias{compression}
+\alias{CompressedOutputStream}
+\alias{CompressedInputStream}
+\title{Compressed stream classes}
+\description{
+\code{CompressedInputStream} and \code{CompressedOutputStream}
+allow you to apply a compression \link{Codec} to an
+input or output stream.
+}
+\section{Factory}{
+
+
+The \code{CompressedInputStream$create()} and \code{CompressedOutputStream$create()}
+factory methods instantiate the object and take the following arguments:
+\itemize{
+\item \code{stream} An \link{InputStream} or \link{OutputStream}, respectively
+\item \code{codec} A \code{Codec}, either a \link{Codec} instance or a string
+\item \code{compression_level} compression level for when the \code{codec} argument is given as a string
+}
+}
+
+\section{Methods}{
+
+
+Methods are inherited from \link{InputStream} and \link{OutputStream}, respectively
+}
+