summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/compression.Rd
diff options
context:
space:
mode:
Diffstat (limited to '')
-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
+}
+