Struct winsafe::FileMapped

source ·
pub struct FileMapped { /* private fields */ }
Available on crate feature kernel only.
Expand description

Manages an HFILEMAP handle, which provides memory-mapped file operations, including read/write through slices. It is closed automatically when the object goes out of scope.

§Examples

Usually the fastest way to read a file as string is by memory-mapping it, like:

use winsafe::{self as w, prelude::*};

let f = w::FileMapped::open(
    "C:\\Temp\\foo.txt",
    w::FileAccess::ExistingReadOnly,
)?;
let raw_bytes = f.as_slice();
let text = w::WString::parse(raw_bytes)?.to_string();

Implementations§

source§

impl FileMapped

source

pub fn open(file_path: &str, access: FileAccess) -> SysResult<Self>

Opens a file with the desired access, then map its contents in memory.

source

pub fn as_mut_slice(&mut self) -> &mut [u8]

Returns a mutable slice to the mapped memory.

source

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

Returns a slice to the mapped memory.

source

pub fn hfile(&self) -> &HFILE

Returns the underlying file handle.

source

pub const fn size(&self) -> u64

Returns the size of the file.

This value is cached.

source

pub fn times(&self) -> SysResult<(SYSTEMTIME, SYSTEMTIME)>

Returns the creation and last write times of the file, in the current time zone.

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.