Struct FileId 

pub struct FileId { /* private fields */ }

The identity of a file on one computer: the serial number of its volume and its 128-bit file identifier, as GetFileInformationByHandleEx’s FileIdInfo class reported them.

Two values are equal when both fields are. What the fields mean beyond that is the call’s: the identifier is carried as its 16 bytes and is not read as an integer, which would impose a byte order the call does not state.

Example

use win_durable_ioring::windows_backend::{Cached, FileOptions, OpenedFile};
use win_durable_ioring::Wtf16String;

let path = std::env::temp_dir().join(format!("file-id-doc-{}.tmp", std::process::id()));
std::fs::write(&path, b"x")?;
let name = || Wtf16String::from_os_str(path.as_os_str());

let first = OpenedFile::<Cached, _>::open(name(), FileOptions::new().read())?;
let second = OpenedFile::<Cached, _>::open(name(), FileOptions::new().read().write())?;

// Two opens of one file report one identity.
assert_eq!(first.file_id()?, second.file_id()?);

Implementations

impl FileId

pub const fn new(volume_serial_number: u64, id: [u8; 16]) -> Self

An identity with these fields, for a caller that holds them from elsewhere, such as a directory listing.

pub fn of(handle: &SharedHandle) -> Result<Self>

The identity of the file handle is open on, read on the calling thread through the handle, which is shared for the call and not duplicated.

Errors

The code the call failed with, unaltered. An event, a pipe, NUL and a volume were observed refused; the FILE_ID_INFO page does not list the codes, so none is promised.

pub const fn volume_serial_number(&self) -> u64

VolumeSerialNumber: the serial number of the volume that contains the file.

pub const fn id(&self) -> [u8; 16]

FileId: the 128-bit file identifier, as its 16 bytes.

Trait Implementations

impl Clone for FileId

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FileId

impl Debug for FileId

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

Formats the value using the given formatter.

impl Eq for FileId

impl From<FileId> for FileIdentifier

fn from(id: FileId) -> Self

Converts to this type from the input type.

impl Hash for FileId

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 PartialEq for FileId

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileId