Skip to main content

FileReader

Struct FileReader 

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

File reader with support for memory mapping.

Automatically chooses the best reading strategy based on file size:

  • Small files (< 1MB): Read directly into memory
  • Large files (>= 1MB): Use memory mapping

§Examples

use rlm_rs::io::FileReader;

let reader = FileReader::open("large_file.txt").unwrap();
let content = reader.read_to_string().unwrap();

Implementations§

Source§

impl FileReader

Source

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

Opens a file for reading.

§Arguments
  • path - Path to the file.
§Errors

Returns an error if the file doesn’t exist or can’t be opened.

Source

pub const fn size(&self) -> u64

Returns the file size in bytes.

Source

pub fn path(&self) -> &str

Returns the file path.

Source

pub fn read_to_string(&self) -> Result<String>

Reads the file content as a string.

Uses memory mapping for large files.

§Errors

Returns an error if reading fails or content is not valid UTF-8.

Source

pub fn read_to_bytes(&self) -> Result<Vec<u8>>

Reads the file content as bytes.

§Errors

Returns an error if reading fails.

Source

pub fn mmap(&self) -> Result<Mmap>

Creates a memory-mapped view of the file.

Useful when you need to access the file content multiple times without copying.

§Errors

Returns an error if memory mapping fails.

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> 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> 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, 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.
Source§

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

Source§

fn vzip(self) -> V