Struct MappedFileSource

pub struct MappedFileSource { /* private fields */ }

A U8Source whose data is owned by a memory mapped file. This source can only use u8s as its item.

An important note: The mapped file is locked first via an advisory lock. This is to prevent changes to the file while it is mapped. However, this is just an advisory lock, and other processes may choose to ignore it. So, it’s best not to alter it while it’s mapped.

Implementations

impl MappedFileSource

pub fn path(&self) -> Option<&Path>

Trait Implementations

impl Drop for MappedFileSource

fn drop(&mut self)

Executes the destructor for this type.

impl Source for MappedFileSource

type Item = u8

The type of item the Source and its generated Segments will hold.

fn size(&self) -> usize

The amount of data in the reader. If the reader’s size changes (which none of the implementations currently do), then this should return how much data was initially in the reader.

fn initial_offset(&self) -> usize

The initial offset of the Source. For more information, see the Offsets section of the Source documentation.

fn from_vec_with_offset( items: Vec<Self::Item>, initial_offset: usize, ) -> Result<Self>

Creates a new source with the provided initial offset, using the items in theVec for its data.

fn segment(&self, start: usize, end: usize) -> Result<Segment<'_, u8>>

Creates a segment from the start offset (inclusive) to the end offset (exclusive).

fn from_vec(items: Vec<Self::Item>) -> Result<Self>

Creates a new source using the data in the Vec for its data.

fn validate_offset(&self, offset: usize) -> Result<()>

Checks to make sure that the provided offset is valid. If it is, then an Ok(()) will be returned. Otherwise, the appropriate error will be returned.

fn all(&self) -> Result<Segment<'_, Self::Item>>

Returns a single segment containing all data in the source.

fn get_n( &self, offset: usize, num_items: usize, ) -> Result<Segment<'_, Self::Item>>

Gets a segment of n items, starting at the given offset.

fn all_before(&self, offset: usize) -> Result<Segment<'_, Self::Item>>

Gets all items in the source before the provided offset (exclusive).

fn all_after(&self, offset: usize) -> Result<Segment<'_, Self::Item>>

Gets all items in the source after the provided offset (inclusive).

fn lower_offset_limit(&self) -> usize

The lowest valid offset that can be requested.

fn upper_offset_limit(&self) -> usize

The highest valid offset that can be requested.

impl U8Source for MappedFileSource

fn from_file_with_offset<P: AsRef<Path>>( path: P, initial_offset: usize, endidness: Endidness, ) -> Result<Self>

Creates a new source using the the provided file, Endidness, and offset.

fn from_bytes_with_offset( bytes: Bytes, initial_offset: usize, endidness: Endidness, ) -> Result<Self>

Creates a new source using the the provided Bytes, Endidness, and offset.

fn from_file_with_offset_async<'async_trait, P>( path: P, initial_offset: usize, endidness: Endidness, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where P: AsRef<Path> + Sync + Send + 'async_trait, Self: 'async_trait,

An async version of U8Source::from_file_with_offset.

fn from_u8_slice_with_offset( bytes: &[u8], initial_offset: usize, endidness: Endidness, ) -> Result<Self>

Creates a new source using the the provided slice, Endidness, and offset.

fn endidness(&self) -> Endidness

The endidness of the source.

fn change_endidness(&mut self, endidness: Endidness)

Changes the default endidness. This does not change the endidness for any Segments that have already been created, but only for Segments that are created in the future.

fn from_u8_slice(slice: &[u8], endidness: Endidness) -> Result<Self>

Creates a new source using the the provided slice and Endidness.

fn from_u8_vec(items: Vec<u8>, endidness: Endidness) -> Result<Self>

Creates a new source using the the provided vec and Endidness.

fn from_u8_vec_with_offset( items: Vec<u8>, initial_offset: usize, endidness: Endidness, ) -> Result<Self>

Creates a new source using the the provided vec, Endidness, and offset.

fn from_file<P: AsRef<Path>>(path: P, endidness: Endidness) -> Result<Self>

Creates a new source using the the provided file and Endidness.

fn from_file_async<'async_trait, P>( path: P, endidness: Endidness, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where P: AsRef<Path> + Sync + Send + 'async_trait, Self: Send + 'async_trait,

An async version of U8Source::from_file.

fn from_bytes(bytes: Bytes, endidness: Endidness) -> Result<Self>

Creates a new source using the the provided Bytes and Endidness.