MMapReader

Struct MMapReader 

Source
pub struct MMapReader { /* private fields */ }
Available on crate feature std only.
Expand description

A file reader for reading data from a file

Implements the Reader trait.

Trait Implementations§

Source§

impl Clone for MMapReader

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MMapReader

Source§

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

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

impl From<&str> for MMapReader

Source§

fn from(path: &str) -> Self

Converts to this type from the input type.
Source§

impl From<PathBuf> for MMapReader

Source§

fn from(path: PathBuf) -> Self

Converts to this type from the input type.
Source§

impl From<String> for MMapReader

Source§

fn from(path: String) -> Self

Converts to this type from the input type.
Source§

impl Reader for MMapReader

Source§

fn len(&self) -> u64

Get the number of bytes in the reader
Source§

fn uint64(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> u64

Get the unsigned 64 bit integer at the given byte offset and endian. Default to big-endian
Source§

fn uint64_be(&self, byte_offset: Option<u64>) -> u64

Get the big-endian unsigned 64 bit integer at the given byte offset
Source§

fn uint64_le(&self, byte_offset: Option<u64>) -> u64

Get the little-endian unsigned 64 bit integer at the given byte offset
Source§

fn int64(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> i64

Get the signed 64 bit integer at the given byte offset and endian. Default to big-endian
Source§

fn int64_be(&self, byte_offset: Option<u64>) -> i64

Get the big-endian signed 64 bit integer at the given byte offset
Source§

fn int64_le(&self, byte_offset: Option<u64>) -> i64

Get the little-endian signed 64 bit integer at the given byte offset
Source§

fn f64(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> f64

Get the 64 bit floating point at the given byte offset and endian. Default to big-endian
Source§

fn f64_be(&self, byte_offset: Option<u64>) -> f64

Get the big-endian floating point 64 bit integer at the given byte offset
Source§

fn f64_le(&self, byte_offset: Option<u64>) -> f64

Get the little-endian floating point 64 bit integer at the given byte offset
Source§

fn uint32(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> u32

Get the unsigned 32 bit integer at the given byte offset and endian. Default to big-endian
Source§

fn uint32_be(&self, byte_offset: Option<u64>) -> u32

Get the big-endian unsigned 32 bit integer at the given byte offset
Source§

fn uint32_le(&self, byte_offset: Option<u64>) -> u32

Get the little-endian unsigned 32 bit integer at the given byte offset
Source§

fn int32(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> i32

Get the signed 32 bit integer at the given byte offset and endian. Default to big-endian
Source§

fn int32_be(&self, byte_offset: Option<u64>) -> i32

Get the big-endian signed 32 bit integer at the given byte offset
Source§

fn int32_le(&self, byte_offset: Option<u64>) -> i32

Get the little-endian signed 32 bit integer at the given byte offset
Source§

fn f32(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> f32

Get the 32 bit floating point at the given byte offset and endian. Default to big-endian
Source§

fn f32_be(&self, byte_offset: Option<u64>) -> f32

Get the big-endian floating point 32 bit integer at the given byte offset
Source§

fn f32_le(&self, byte_offset: Option<u64>) -> f32

Get the little-endian floating point 32 bit integer at the given byte offset
Source§

fn uint16(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> u16

Get the unsigned 16 bit integer at the given byte offset and endian. Default to big-endian
Source§

fn uint16_be(&self, byte_offset: Option<u64>) -> u16

Get the big-endian unsigned 16 bit integer at the given byte offset
Source§

fn uint16_le(&self, byte_offset: Option<u64>) -> u16

Get the little-endian unsigned 16 bit integer at the given byte offset
Source§

fn int16(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> i16

Get the signed 16 bit integer at the given byte offset and endian. Default to big-endian
Source§

fn int16_be(&self, byte_offset: Option<u64>) -> i16

Get the big-endian signed 16 bit integer at the given byte offset
Source§

fn int16_le(&self, byte_offset: Option<u64>) -> i16

Get the little-endian signed 16 bit integer at the given byte offset
Source§

fn f16(&self, byte_offset: Option<u64>, little_endian: Option<bool>) -> f32

Get the 16 bit floating point at the given byte offset and endian. Default to big-endian
Source§

fn f16_be(&self, byte_offset: Option<u64>) -> f32

Get the big-endian floating point 16 bit integer at the given byte offset
Source§

fn f16_le(&self, byte_offset: Option<u64>) -> f32

Get the little-endian floating point 16 bit integer at the given byte offset
Source§

fn uint8(&self, byte_offset: Option<u64>) -> u8

Get the unsigned 8 bit integer at the given byte offset
Source§

fn int8(&self, byte_offset: Option<u64>) -> i8

Get the signed 8 bit integer at the given byte offset
Source§

fn tell(&self) -> u64

Seek to the given byte offset
Source§

fn seek(&self, pos: u64)

Seek to the given byte offset
Source§

fn slice(&self, begin: Option<u64>, end: Option<u64>) -> Vec<u8>

Get a slice of the reader
Source§

fn seek_slice(&self, size: usize) -> Vec<u8>

Get a slice of the reader at the current position
Source§

fn parse_string( &self, byte_offset: Option<u64>, byte_length: Option<u64>, ) -> String

Parse a string from the reader
Source§

fn is_empty(&self) -> bool

See if empty
Source§

fn get_slice<'a>( &'a self, byte_offset: u64, byte_length: Option<u64>, ) -> impl Future<Output = Vec<u8>> + 'a

Fetch based mechanic. Defaults to slice mechanic
Source§

impl StdReader for MMapReader

Source§

fn new<P: AsRef<Path>>(path: P) -> Result<Self>

Creates a new file reader from a file path

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V