Expand description
A Rust library for reading and writing R RDS files without requiring an R runtime.
This library provides functionality to serialize and deserialize R objects to/from the RDS binary format.
Modules§
- constants
- Constants for RDS file format.
Structs§
- Attributes
- Attributes attached to R objects Optimized with SmallVec to avoid heap allocation for common case of 0-2 attributes
- Chunk
Config - Chunked
Cache Metrics - Chunked
RdsSource - Complex
- Represents a complex number
- Data
Frame Data - Data frame structure (boxed to reduce RObject enum size)
- Data
Frame Metadata - Dataset
Info - Extracted
Vector Info - Extraction
Output - Extraction
Result - Factor
Data - Factor structure (boxed to reduce RObject enum size)
- Lazy
Vector - Lazy vector metadata for deferred loading.
- Manifest
- Manifest
Vector - Materialization
Context - Mmap
RdsSource - Object
Extraction Output - Object
Path - Structured path for selective loading.
- Pairlist
Element - An element in a pairlist, optionally tagged
- Parse
Config - Configuration for parsing RDS files.
- Parse
Result - S3Object
Data - S3 object structure (boxed to reduce RObject enum size)
- S4Metadata
- S4Object
Data - S4 object structure (boxed to reduce RObject enum size)
- S4Slot
Policy - Policy controlling how S4 slot pairlists are handled during lazy parsing.
- Streaming
Progress - Vector
File Header - Vector
Metadata
Enums§
- Character
Chunk Iter - Chunk
Action - Endian
- Error
- Errors that can occur during RDS parsing or writing.
- Logical
- Represents a logical value in R (TRUE, FALSE, or NA)
- Metadata
Warning - Object
Kind - Parse
Mode - Parsing mode for RDS files.
- RObject
- Represents any R object that can be stored in an RDS file.
- Streaming
Error - Vector
Chunk Iter - Vector
Data - Vector data that can be either fully loaded or lazy.
- Vector
Kind - Visit
Action
Traits§
Functions§
- convert_
object_ to_ raw_ dump - convert_
object_ to_ raw_ dump_ at_ path - expand_
dataframe_ paths - expand_
dense_ matrix_ paths - expand_
list_ index_ paths - expand_
object_ paths - expand_
object_ paths_ for_ kind - expand_
s4_ slot_ paths - expand_
sparse_ matrix_ paths - extract_
complex_ vector_ streaming - extract_
integer_ vector_ streaming - extract_
logical_ vector_ streaming - extract_
object_ from_ path - extract_
object_ from_ path_ chunked - extract_
object_ from_ path_ with_ kind - extract_
object_ from_ path_ with_ kind_ chunked - extract_
object_ to_ raw_ files - extract_
object_ to_ raw_ files_ with_ input_ streaming - extract_
object_ to_ raw_ files_ with_ kind - extract_
object_ to_ raw_ files_ with_ kind_ and_ input_ streaming - extract_
raw_ vector_ streaming - extract_
real_ vector_ streaming - extract_
vectors_ from_ path - extract_
vectors_ from_ path_ chunked - extract_
vectors_ streaming - extract_
vectors_ to_ raw_ files - inspect_
metadata_ streaming - materialize_
complex_ data - materialize_
complex_ vector - materialize_
integer_ data - materialize_
integer_ vector - materialize_
logical_ data - materialize_
logical_ vector - materialize_
path - materialize_
paths_ with_ budget - materialize_
raw_ data - materialize_
raw_ vector - materialize_
real_ data - materialize_
real_ vector - read_
extraction_ manifest - read_
lazy_ character_ range - read_
lazy_ complex_ range - read_
lazy_ integer_ range - read_
lazy_ logical_ range - read_
lazy_ raw_ range - read_
lazy_ real_ range - read_
rds - Read an RDS file from a byte slice with default safety limits.
- read_
rds_ from_ path - Read an RDS file from a file path with default configuration.
- read_
rds_ from_ path_ chunked - Read an RDS file from a file path with default configuration, backed by chunked reads.
- read_
rds_ from_ path_ chunked_ with_ config - Read an RDS file from a file path with custom configuration, backed by chunked reads.
- read_
rds_ from_ path_ with_ config - Read an RDS file from a file path with custom configuration.
- read_
rds_ lazy - Read an RDS file in lazy mode (metadata only, no vector data allocation).
- read_
rds_ lazy_ from_ path - Read an RDS file from a file path in lazy metadata mode.
- read_
rds_ lazy_ from_ path_ chunked - Read an RDS file from a file path in lazy metadata mode, backed by chunked reads.
- read_
rds_ lazy_ with_ input - Read an RDS file from an input source in lazy metadata mode.
- read_
rds_ with_ config - Read an RDS file from a byte slice with custom configuration.
- read_
rds_ with_ input - Read an RDS file from an input source with custom configuration.
- read_
vector_ file_ header - traverse_
rds_ streaming - traverse_
rds_ streaming_ with_ progress - validate_
vector_ file_ header - write_
extraction_ manifest - write_
extraction_ manifest_ with_ kind - write_
rds - Write an RObject to RDS format. Returns gzip-compressed RDS data.
- write_
rds_ atomic - Write an RObject to disk atomically (native only).
- write_
rds_ streaming - Streaming writer APIs.
- write_
rds_ streaming_ with_ compression - Write an RObject to a streaming sink with an explicit compression level.
Type Aliases§
- Result
- Result type alias using our Error type.
- Streaming
Result