Skip to main content

FileReader

Struct FileReader 

Source
pub struct FileReader { /* private fields */ }
Expand description

A .verit file read into memory, owning its bytes.

FileView borrows the image it reads, which means it cannot be stored in the same struct as the buffer it points into — so every caller ends up writing the same { bytes: Vec<u8> } wrapper. This is that wrapper, once.

let file = FileReader::open("events.verit")?;
let view = file.view()?;
for i in 0..view.len() {
    println!("{}", view.dump_json(i)?);
}

For a large file, mmap it with your platform’s facility and hand the mapped &[u8] to FileView::open directly — the reader never copies a record either way, and a map avoids reading bytes nothing touches.

Implementations§

Source§

impl FileReader

Source

pub fn open<P: AsRef<Path>>(path: P) -> Result<FileReader>

Read and validate a file. Structural errors surface here rather than at first access.

Source

pub fn from_bytes(bytes: Vec<u8>) -> Result<FileReader>

Take ownership of an already-read image, validating it.

Source

pub fn view(&self) -> Result<FileView<'_>>

A zero-copy view over the owned bytes.

Source

pub fn bytes(&self) -> &[u8]

The raw image.

Trait Implementations§

Source§

impl Clone for FileReader

Source§

fn clone(&self) -> FileReader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileReader

Source§

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

Formats the value using the given formatter. 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.