Struct winapi_util::Handle

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

A handle represents an owned and valid Windows handle to a file-like object.

When an owned handle is dropped, then the underlying raw handle is closed. To get a borrowed handle, use HandleRef.

Implementations

impl Handle

pub fn from_file(file: File) -> Handle

Create an owned handle to the given file.

When the returned handle is dropped, the file is closed.

Note that if the given file represents a handle to a directory, then it is generally required that it have been opened with the FILE_FLAG_BACKUP_SEMANTICS flag in order to use it in various calls such as information or typ. To have this done automatically for you, use the from_path_any constructor.

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Handle>

Open a file to the given file path, and return an owned handle to that file.

When the returned handle is dropped, the file is closed.

If there was a problem opening the file, then the corresponding error is returned.

pub fn from_path_any<P: AsRef<Path>>(path: P) -> Result<Handle>

Like from_path, but supports opening directory handles as well.

If you use from_path on a directory, then subsequent queries using that handle will fail.

pub fn as_file(&self) -> &File

Return this handle as a standard File reference.

pub fn as_file_mut(&mut self) -> &mut File

Return this handle as a standard File mutable reference.

Trait Implementations

impl AsHandleRef for Handle

fn as_handle_ref(&self) -> HandleRef

A borrowed handle that wraps the raw handle of the Self object.

fn as_raw(&self) -> RawHandle

A convenience routine for extracting a HandleRef from Self, and then extracting a raw handle from the HandleRef.

impl AsRawHandle for Handle

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle.

impl Debug for Handle

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

Formats the value using the given formatter.

impl FromRawHandle for Handle

unsafe fn from_raw_handle(handle: RawHandle) -> Handle

Constructs a new I/O object from the specified raw handle.

impl IntoRawHandle for Handle

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle.