Skip to main content

FileHandle

Struct FileHandle 

Source
pub struct FileHandle {
    pub handle: HANDLE,
}
Expand description

§Windows File Handle Wrapper

Introduces a Rust-friendly wrapper around the native Windows HANDLE object, FileHandle. FileHandle provides safe creation and automatic cleanup of Windows file handles, leveraging Rust’s ownership model.

FileHandle struct that wraps a native Windows HANDLE object

Fields§

§handle: HANDLE

Implementations§

Source§

impl FileHandle

Source

pub unsafe fn new( file_name: &str, access_mode: AccessMode, share_mode: ShareMode, ) -> Result<Self>

Creates a new FileHandle by opening an existing file with the given access and shared mode.

This function is marked unsafe because it creates a raw pointer to the filename and try to create a Windows HANDLE object without checking if you have sufficient permissions.

§Safety

Ensure that the file specified by file_name is valid and the calling process has sufficient permissions to perform the specified access_mode and share_mode operations.

§Parameters
  • file_name: The name of the file.
  • access_mode: The access mode to be used for the file.
  • share_mode: The share mode to be used for the file
§Errors

This function will return an error if the file_name is invalid or if the file cannot be opened with the specified access_mode and share_mode.

Trait Implementations§

Source§

impl Default for FileHandle

Returns a FileHandle with an INVALID_HANDLE_VALUE.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for FileHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for FileHandle

Source§

impl Sync for FileHandle

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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>,

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

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more