qsave_handle: qsave_handle

Description Usage Arguments Details Value

View source: R/RcppExports.R

Description

Saves an object to a windows handle

Usage

1
2
3
qsave_handle(x, handle, 
preset = "high", algorithm = "zstd", compress_level = 4L, 
shuffle_control = 15L, check_hash=TRUE)

Arguments

x

the object to serialize.

handle

A windows handle external pointer

preset

One of "fast", "balanced" , "high" (default), "archive", "uncompressed" or "custom". See details.

algorithm

Compression algorithm used: "lz4", "zstd", "lz4hc", "zstd_stream" or "uncompressed".

compress_level

The compression level used (Default 4). For lz4, this number must be > 1 (higher is less compressed). For zstd, a number between -50 to 22 (higher is more compressed).

shuffle_control

An integer setting the use of byte shuffle compression. A value between 0 and 15 (Default 15). See details.

check_hash

Default TRUE, compute a hash which can be used to verify file integrity during serialization

Details

This function serializes and compresses an R object to a stream using a file descriptor If your data is important, make sure you know what happens on the other side of the pipe. See examples for usage.

Value

the number of bytes serialized (returned invisibly)


qs documentation built on Nov. 6, 2021, 1:07 a.m.