LinearReaderOptions

Struct LinearReaderOptions 

Source
pub struct LinearReaderOptions {
    pub skip_start_magic: bool,
    pub skip_end_magic: bool,
    pub check_finishes_after_end_magic: bool,
    pub emit_chunks: bool,
    pub validate_chunk_crcs: bool,
    pub prevalidate_chunk_crcs: bool,
    pub validate_data_section_crc: bool,
    pub validate_summary_section_crc: bool,
    pub record_length_limit: Option<usize>,
}
Expand description

Options for initializing LinearReader.

Fields§

§skip_start_magic: bool

If true, the reader will not expect the MCAP magic at the start of the stream.

§skip_end_magic: bool

If true, the reader will not expect the MCAP magic after the footer record.

§check_finishes_after_end_magic: bool

If skip_end_magic is false and this is true, the reader will check that there are no bytes after the end magic.

§emit_chunks: bool

If true, the reader will yield entire chunk records. Otherwise, the reader will decompress and read into chunks, yielding the records inside.

§validate_chunk_crcs: bool

Enables chunk CRC validation. Ignored if prevalidate_chunk_crcs: true.

§prevalidate_chunk_crcs: bool

Enables chunk CRC validation before yielding any messages from the chunk. Implies validate_chunk_crcs: true.

§validate_data_section_crc: bool

Enables data section CRC validation.

§validate_summary_section_crc: bool

Enables summary section CRC validation.

§record_length_limit: Option<usize>

If Some(limit), the reader will return an error on any non-chunk record with length > limit. If used in conjunction with prevalidate_chunk_crcs, the reader will return an error on any chunk record where the compressed OR decompressed length are > limit.

Implementations§

Source§

impl LinearReaderOptions

Source

pub fn with_skip_start_magic(self, skip_start_magic: bool) -> Self

Source

pub fn with_skip_end_magic(self, skip_end_magic: bool) -> Self

Source

pub fn with_check_finishes_after_end_magic( self, check_finishes_after_end_magic: bool, ) -> Self

Source

pub fn with_emit_chunks(self, emit_chunks: bool) -> Self

Source

pub fn with_validate_chunk_crcs(self, validate_chunk_crcs: bool) -> Self

Source

pub fn with_prevalidate_chunk_crcs(self, prevalidate_chunk_crcs: bool) -> Self

Source

pub fn with_validate_data_section_crc( self, validate_data_section_crc: bool, ) -> Self

Source

pub fn with_validate_summary_section_crc( self, validate_summary_section_crc: bool, ) -> Self

Source

pub fn with_record_length_limit(self, record_length_limit: usize) -> Self

Trait Implementations§

Source§

impl Clone for LinearReaderOptions

Source§

fn clone(&self) -> LinearReaderOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinearReaderOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LinearReaderOptions

Source§

fn default() -> LinearReaderOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.