Enum FileIdentifier 

pub enum FileIdentifier {
    FileId(u64),
    ObjectId(u128),
    ExtendedFileId([u8; 16]),
}

Which kind of identifier names the object to open.

Win32 spells this as a tagged union whose tag and payload must be kept in step by hand; here the tag is implied by the variant, so the two cannot disagree.

All three forms are supported. Only FileId appears in the audited consumers, but an entry that could express one of its own call’s three identifier kinds would be a narrowed OpenFileById.

Example

The tag is implied by the variant, so it cannot disagree with the payload the way the raw union permits:

use windows_namespace_request_sys::open_by_id::FileIdentifier;
use windows_sys::Win32::Storage::FileSystem::{
    ExtendedFileIdType, FileIdType, ObjectIdType,
};

assert_eq!(FileIdentifier::FileId(7).id_type(), FileIdType);
assert_eq!(FileIdentifier::ObjectId(0x1234).id_type(), ObjectIdType);
assert_eq!(FileIdentifier::ExtendedFileId([0; 16]).id_type(), ExtendedFileIdType);

Variants

FileId(u64)

A 64-bit file reference number, as reported by FileIdInfo’s predecessor and by BY_HANDLE_FILE_INFORMATION. This is the form every audited consumer uses.

ObjectId(u128)

A volume-scoped object identifier.

Taken as a u128 rather than a GUID deliberately. Win32’s GUID is a dependency’s type that implements neither equality nor Debug, and a public surface should not be shaped by whichever binding crate this happens to build against. The conversion to GUID happens at the FFI boundary, where it belongs.

ExtendedFileId([u8; 16])

A 128-bit file reference number, as reported by FileIdInfo on ReFS, where 64 bits is not enough to name a file.

Implementations

impl FileIdentifier

pub fn id_type(self) -> FILE_ID_TYPE

The FILE_ID_TYPE tag Win32 pairs with this identifier.

Trait Implementations

impl Clone for FileIdentifier

fn clone(&self) -> FileIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FileIdentifier

impl Debug for FileIdentifier

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

Formats the value using the given formatter.

impl Eq for FileIdentifier

impl Hash for FileIdentifier

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 FileIdentifier

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FileIdentifier