Struct winsafe::HFILE

pub struct HFILE(/* private fields */);

Available on crate feature kernel only.

Handle to a file. Originally just a HANDLE.

Unless you need something specific, consider using the File high-level abstraction.

Trait Implementations

impl Debug for HFILE

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

Formats the value using the given formatter.

impl Display for HFILE

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

Formats the value using the given formatter.

impl Handle for HFILE

const NULL: Self = _

The null, uninitialized handle; equals to 0.

const INVALID: Self = _

The invalid handle; equals to -1.

unsafe fn from_ptr(p: *mut c_void) -> Self

Creates a new handle object by wrapping a pointer.

unsafe fn as_mut(&mut self) -> &mut *mut c_void

Returns a mutable reference to the underlying raw pointer.

unsafe fn raw_copy(&self) -> Self

Returns a raw copy of the underlying handle pointer.

fn ptr(&self) -> *mut c_void

Returns the underlying raw pointer.

fn as_opt(&self) -> Option<&Self>

Returns None if the handle is null or invalid, otherwise returns Some(&self).

impl Hash for HFILE

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for HFILE

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

Formats the value using the given formatter.

impl PartialEq for HFILE

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UpperHex for HFILE

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

Formats the value using the given formatter.

impl kernel_Hfile for HFILE

fn CreateFile( file_name: &str, desired_access: GENERIC, share_mode: Option<FILE_SHARE>, security_attributes: Option<&mut SECURITY_ATTRIBUTES<'_>>, creation_disposition: DISPOSITION, attributes: FILE_ATTRIBUTE, flags: Option<FILE_FLAG>, security: Option<FILE_SECURITY>, hfile_template: Option<&HFILE> ) -> SysResult<(CloseHandleGuard<HFILE>, ERROR)>

CreateFile function.

fn CreateFileMapping( &self, mapping_attrs: Option<&mut SECURITY_ATTRIBUTES<'_>>, protect: PAGE, max_size: Option<u64>, mapping_name: Option<&str> ) -> SysResult<CloseHandleGuard<HFILEMAP>>

CreateFileMapping function.

fn GetFileInformationByHandle( &self, fi: &mut BY_HANDLE_FILE_INFORMATION ) -> SysResult<()>

GetFileInformationByHandle function.

fn GetFileSizeEx(&self) -> SysResult<u64>

GetFileSizeEx function.

fn GetFileTime( &self, creation_time: Option<&mut FILETIME>, last_access_time: Option<&mut FILETIME>, last_write_time: Option<&mut FILETIME> ) -> SysResult<()>

GetFileTime function.

fn GetFileType(&self) -> SysResult<FILE_TYPE>

GetFileType function.

fn LockFile( &self, offset: u64, num_bytes_to_lock: u64 ) -> SysResult<UnlockFileGuard<'_, Self>>

LockFile function.

fn ReadFile(&self, buffer: &mut [u8]) -> SysResult<u32>

ReadFile function.

fn SetEndOfFile(&self) -> SysResult<()>

SetEndOfFile function.

fn SetFilePointerEx( &self, distance_to_move: i64, move_method: FILE_STARTING_POINT ) -> SysResult<i64>

SetFilePointerEx function.

fn SetFileTime( &self, creation_time: Option<&FILETIME>, last_access_time: Option<&FILETIME>, last_write_time: Option<&FILETIME> ) -> SysResult<()>

SetFileTime function.

fn WriteFile(&self, data: &[u8]) -> SysResult<u32>

WriteFile function.

impl Eq for HFILE

impl Send for HFILE

impl StructuralPartialEq for HFILE