Struct QueryFileInformationByHandle 

pub struct QueryFileInformationByHandle { /* private fields */ }

An owned, marshalable parameter set for GetFileInformationByHandle.

Example

use std::fs;
use std::os::windows::io::AsHandle;

use windows_namespace_request_sys::file_info::QueryFileInformationByHandle;
use windows_namespace_request_sys::CapturedHandle;

let path = std::env::temp_dir().join(format!("wnrs-fi-{}.tmp", std::process::id()));
fs::write(&path, b"example")?;
let file = fs::File::open(&path)?;

let information = QueryFileInformationByHandle::new(
    CapturedHandle::capture(file.as_handle())?,
)
.perform()?;

// The 64-bit file index this call reports in one shot, which the Ex form's
// FileIdInfo does not give in this shape.
let index = (u64::from(information.nFileIndexHigh) << 32)
    | u64::from(information.nFileIndexLow);
assert_ne!(index, 0);
assert_eq!(information.nFileSizeLow, b"example".len() as u32);

Implementations

impl QueryFileInformationByHandle

pub fn new(handle: CapturedHandle) -> Self

Begins a request against handle.

pub fn handle(&self) -> &CapturedHandle

The owned duplicate of the handle being queried.

pub fn try_clone(&self) -> Result<Self, HandleCaptureError>

Copies the request, duplicating the handle.

Errors

Returns the handle-capture failure when the handle cannot be duplicated.

pub fn perform(&self) -> Outcome<BY_HANDLE_FILE_INFORMATION>

Performs the query on the calling thread.

Errors

Returns the raw Win32 code, unaltered.

Trait Implementations

impl Debug for QueryFileInformationByHandle

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

Formats the value using the given formatter.

impl Request for QueryFileInformationByHandle

type Error = Win32Error

How performing it can fail.

type Output = BY_HANDLE_FILE_INFORMATION

What performing the request produces.

fn perform(&self) -> Outcome<BY_HANDLE_FILE_INFORMATION>

Performs the request on the calling thread.