summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/Codec.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/Codec.Rd
parentInitial commit. (diff)
downloadceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz
ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--src/arrow/r/man/Codec.Rd24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/arrow/r/man/Codec.Rd b/src/arrow/r/man/Codec.Rd
new file mode 100644
index 000000000..86723aed5
--- /dev/null
+++ b/src/arrow/r/man/Codec.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/compression.R
+\docType{class}
+\name{Codec}
+\alias{Codec}
+\title{Compression Codec class}
+\description{
+Codecs allow you to create \link[=compression]{compressed input and output streams}.
+}
+\section{Factory}{
+
+The \code{Codec$create()} factory method takes the following arguments:
+\itemize{
+\item \code{type}: string name of the compression method. Possible values are
+"uncompressed", "snappy", "gzip", "brotli", "zstd", "lz4", "lzo", or
+"bz2". \code{type} may be upper- or lower-cased. Not all methods may be
+available; support depends on build-time flags for the C++ library.
+See \code{\link[=codec_is_available]{codec_is_available()}}. Most builds support at least "snappy" and
+"gzip". All support "uncompressed".
+\item \code{compression_level}: compression level, the default value (\code{NA}) uses the
+default compression level for the selected compression \code{type}.
+}
+}
+