Struct winsafe::HFILEMAPVIEW

#[repr(C)]
pub struct HFILEMAPVIEW { /* fields omitted */ }

Address of a mapped view. Originally just an LPVOID.

Implementations

impl HFILEMAPVIEW

pub const NULL: Self

The null, invalid handle.

This constant is common to all handle types.

pub unsafe fn from_ptr<T>(p: *mut T) -> HFILEMAPVIEW

Creates a new handle instance by wrapping a pointer.

This method is common to all handle types.

pub unsafe fn as_ptr(self) -> *mut c_void

Consumes the handle returning the underlying raw pointer.

This method is common to all handle types.

pub fn is_null(self) -> bool

Tells if the handle is invalid (null).

This method is common to all handle types.

pub fn as_opt(self) -> Option<HFILEMAPVIEW>

Consumes the handle into an option, which is None if the handle pointer is null.

This method is common to all handle types.

impl HFILEMAPVIEW

pub fn UnmapViewOfFile(self) -> WinResult<()>

UnmapViewOfFile method.

pub fn as_mut_slice<'a>(self, len: usize) -> &'a mut [u8]

Returns a slice representing the mapped memory. You can modify the contents. You should call this method only if the file has write access.

Note: If the file is resized to a smaller size, the slice will still map the bytes beyond the file. This may cause serious errors. So, if the file is resized, re-generate the slice by calling as_slice again.

pub fn as_slice<'a>(self, len: usize) -> &'a [u8]

Returns a slice representing the mapped memory.

Note: If the file is resized to a smaller size, the slice will still map the bytes beyond the file. This may cause serious errors. So, if the file is resized, re-generate the slice by calling as_slice again.

Examples

Reading the contents of a file into a string:

use winsafe::{co, HFILE};

let hfile = HFILE::CreateFile(
    "C:\\Temp\\test.txt",
    co::GENERIC::READ,
    co::FILE_SHARE::READ,
    None,
    co::DISPOSITION::OPEN_EXISTING,
    co::FILE_ATTRIBUTE::NORMAL,
    None,
)?;

let hmap = hfile.CreateFileMapping(
    None,
    co::PAGE::READONLY,
    None,
    None,
)?;

let view = hmap.MapViewOfFile(co::FILE_MAP::READ, 0, None)?;

let slice = view.as_slice(hfile.GetFileSizeEx()?);
let text = std::str::from_utf8(slice)?;

view.UnmapViewOfFile()?;
hmap.CloseHandle()?;
hfile.CloseHandle()?;

println!("{}", text);

Trait Implementations

impl Binary for HFILEMAPVIEW

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

Formats the value using the given formatter.

impl Clone for HFILEMAPVIEW

fn clone(&self) -> HFILEMAPVIEW

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HFILEMAPVIEW

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

Formats the value using the given formatter.

impl Display for HFILEMAPVIEW

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

Formats the value using the given formatter.

impl LowerHex for HFILEMAPVIEW

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

Formats the value using the given formatter.

impl Octal for HFILEMAPVIEW

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

Formats the value using the given formatter.

impl PartialEq<HFILEMAPVIEW> for HFILEMAPVIEW

fn eq(&self, other: &HFILEMAPVIEW) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HFILEMAPVIEW) -> bool

This method tests for !=.

impl UpperHex for HFILEMAPVIEW

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

Formats the value using the given formatter.

impl Copy for HFILEMAPVIEW

impl Eq for HFILEMAPVIEW

impl Send for HFILEMAPVIEW

impl StructuralEq for HFILEMAPVIEW

impl StructuralPartialEq for HFILEMAPVIEW

impl Sync for HFILEMAPVIEW