File: Codec.Rd

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (24 lines) | stat: -rw-r--r-- 959 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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}.
}
}