Struct ByIdRequest 

pub struct ByIdRequest<B: Buffering = Cached, A: DataAccess = ReadWrite> { /* private fields */ }

The request to open a file by identifier, built by OpenedFile::request_by_id and made by perform. It holds the hint, shared, so the handle it was built from can be closed first; it is Send, so it can be performed on a thread that can afford to block; and it can be performed more than once, each time opening the file again.

Implementations

impl<B: Buffering, A: DataAccess> ByIdRequest<B, A>

pub fn identifier(&self) -> FileIdentifier

The identifier this request opens.

pub fn volume_hint(&self) -> &SharedHandle

The hint whose volume the identifier is opened on, shared with its other holders.

pub fn perform(&self) -> Result<OpenedFile<B, A>>

Open the file, on the calling thread. This blocks for as long as OpenFileById does.

Errors

• SharingViolation (as an io::ErrorKind::ResourceBusy error), naming the file by OpenedBy::Identifier, when the file is open in a way that conflicts with this open’s access or sharing.
• For a FileIdentifier::Extended, IdentityMismatch (as an io::ErrorKind::InvalidInput error) when the file opened is not the identity asked for, which is a hint on another volume; the handle is closed. An error reading the opened file’s identity is returned as it came.
• The path open’s checks, RemoteDevice and UnknownLocation, made on the opened handle by the same code. No test reaches them by identifier: the page lists SMB as not supported, so an open by identifier on a share is the kernel’s to refuse, and the call opens only a file on a file system, whose final path is readable.
• Otherwise whatever OpenFileById reports, unaltered. The page names one, ERROR_ACCESS_DENIED for a file pending deletion; an identifier that names nothing is the kernel’s error, and the page does not say which.

Trait Implementations

impl<B: Debug + Buffering, A: Debug + DataAccess> Debug for ByIdRequest<B, A>

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

Formats the value using the given formatter.