Struct Record 

pub struct Record { /* private fields */ }

A validated record: verified canonical bytes from one retained source.

Its metadata (fields, links, By/Mark, lengths, containment) is always in memory. The complete bytes are available as one slice only where the source is contiguous; Record::read_at reads any source in bounded pieces. Clones share the source. Equality and hashing use the record hash.

Implementations

impl Record

pub fn from_bytes(bytes: impl Into<Vec<u8>>) -> Result<Record, RecordError>

Validate complete canonical record bytes (Lace-010) and own them.

pub fn hash(&self) -> RecordHash

pub fn kind(&self) -> RecordKind

pub fn canonical_len(&self) -> usize

The complete canonical length in bytes.

pub fn metadata(&self) -> RecordMetadata<'_>

The canonical non-payload prefix and everything derived from it.

pub fn contiguous_bytes(&self) -> Option<&[u8]>

The complete canonical bytes, when the source holds them contiguously: memory and native mmap records, not file ranges.

pub fn contiguous_data(&self) -> Option<&[u8]>

The Blob data, when the source holds it contiguously.

pub fn read_at(&self, offset: usize, buffer: &mut [u8]) -> Result<usize, Error>

Copy canonical bytes starting at offset into buffer and return how many were copied: fewer than buffer.len() only at the record’s end. A file-range record reads its file at the matching position.

pub fn to_vec(&self, limit: usize) -> Result<Vec<u8>, RecordReadError>

The complete canonical bytes, if at most limit bytes long.

pub fn data_to_vec(&self, limit: usize) -> Result<Vec<u8>, RecordReadError>

The Blob data, if at most limit bytes long.

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Record

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Record

impl Hash for Record

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoRecordBatch for Record

fn into_records(self) -> Vec<Record>

impl IntoRecordBatch for &Record

fn into_records(self) -> Vec<Record>

impl PartialEq for Record

fn eq(&self, other: &Record) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.