Skip to main content

Crate tensogram

Crate tensogram 

Source

Re-exports§

pub use decode::DecodeOptions;
pub use decode::DecodedMaskSet;
pub use decode::DecodedObjectWithMasks;
pub use decode::decode;
pub use decode::decode_descriptors;
pub use decode::decode_metadata;
pub use decode::decode_object;
pub use decode::decode_range;
pub use decode::decode_range_from_payload;
pub use decode::decode_with_masks;
pub use dtype::Dtype;
pub use encode::AggregateHashPolicy;
pub use encode::EncodeOptions;
pub use encode::encode;
pub use encode::encode_pre_encoded;
pub use error::Result;
pub use error::TensogramError;
pub use file::MessageLayout;
pub use file::TensogramFile;
pub use framing::ScanOptions;
pub use framing::data_object_inline_hashes;
pub use framing::scan;
pub use framing::scan_file;
pub use framing::scan_file_with_options;
pub use framing::scan_with_options;
pub use hash::HASH_ALGORITHM_NAME;
pub use hash::compute_hash;
pub use hash::parse_hash_name;
pub use iter::FileMessageIter;
pub use iter::MessageIter;
pub use iter::ObjectIter;
pub use iter::messages;
pub use iter::objects;
pub use iter::objects_metadata;
pub use metadata::RESERVED_KEY;
pub use metadata::compute_common;
pub use metadata::verify_canonical_cbor;
pub use pipeline::DEFAULT_SIMPLE_PACKING_BITS;
pub use pipeline::DataPipeline;
pub use pipeline::apply_pipeline;
pub use remote_scan_parse::BackwardCommit;
pub use remote_scan_parse::BackwardOutcome;
pub use remote_scan_parse::ForwardOutcome;
pub use remote_scan_parse::footer_region_present;
pub use remote_scan_parse::parse_backward_postamble;
pub use remote_scan_parse::parse_forward_preamble;
pub use remote_scan_parse::same_message_check;
pub use remote_scan_parse::validate_backward_preamble;
pub use scan_opts::RemoteScanOptions;
pub use streaming::StreamingEncoder;
pub use types::DataObjectDescriptor;
pub use types::DecodedObject;
pub use types::GlobalMetadata;
pub use types::HashFrame;
pub use types::IndexFrame;
pub use types::MaskDescriptor;
pub use types::MasksMetadata;
pub use validate::FileIssue;
pub use validate::FileValidationReport;
pub use validate::IssueCode;
pub use validate::IssueSeverity;
pub use validate::ValidateOptions;
pub use validate::ValidationIssue;
pub use validate::ValidationLevel;
pub use validate::ValidationReport;
pub use validate::validate_buffer;
pub use validate::validate_file;
pub use validate::validate_message;
pub use wire::FrameType;
pub use wire::MessageFlags;
pub use wire::WIRE_VERSION;
pub use remote::is_remote_url;

Modules§

decode
doctor
Environment diagnostics for tensogram.
dtype
encode
error
file
framing
hash
iter
Iterator types for lazy traversal of messages and objects.
metadata
pipeline
Shared encoding/filter/compression pipeline helpers for importers.
remote
Remote object store backend for TensogramFile.
remote_scan_parse
Pure parsing primitives for the bidirectional remote-scan walker.
scan_opts
Reader-side scan-walker configuration shared by every backend.
streaming
types
validate
Validation of tensogram messages and files.
wire

Enums§

ByteOrder
CompressionBackend
Selects which backend to use when both FFI and pure-Rust implementations are compiled in for the same codec (szip or zstd).
MaskMethod
Bitmask compression method selector. Serialised in the CBOR descriptor’s masks[kind].method field; see plans/WIRE_FORMAT.md §6.5.1 for the schema.

Constants§

DEFAULT_PARALLEL_THRESHOLD_BYTES
Default threshold below which the library runs sequentially even when threads > 0. Chosen to be well above the per-call rayon pool construction cost (~10 µs) but small enough not to starve encode paths that want parallelism.
ENV_THREADS
Env var consulted when the caller-provided threads is 0.