Enum FileId

pub enum FileId {
    Inode {
        device_id: u64,
        inode_number: u64,
    },
    LowRes {
        volume_serial_number: u32,
        file_index: u64,
    },
    HighRes {
        volume_serial_number: u64,
        file_id: u128,
    },
}

Unique identifier of a file

Variants

Inode

Inode number, available on Linux and macOS.

Fields

device_id: u64

Device ID

inode_number: u64

Inode number

LowRes

Low resolution file ID, available on Windows XP and above.

Compared to the high resolution variant, only the lower parts of the IDs are stored.

On Windows, the low resolution variant can be requested explicitly with the get_low_res_file_id function.

Details: https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfileinformationbyhandle.

Fields

volume_serial_number: u32

Volume serial number

file_index: u64

File index

HighRes

High resolution file ID, available on Windows Vista and above.

On Windows, the high resolution variant can be requested explicitly with the get_high_res_file_id function.

Details: https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-getfileinformationbyhandleex.

Fields

volume_serial_number: u64

Volume serial number

file_id: u128

File ID

Implementations

impl FileId

pub fn new_inode(device_id: u64, inode_number: u64) -> Self

pub fn new_low_res(volume_serial_number: u32, file_index: u64) -> Self

pub fn new_high_res(volume_serial_number: u64, file_id: u128) -> Self

Trait Implementations

impl Clone for FileId

fn clone(&self) -> FileId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileId

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

Formats the value using the given formatter.

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

fn cmp(&self, other: &FileId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FileId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FileId

fn partial_cmp(&self, other: &FileId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for FileId

impl Eq for FileId

impl StructuralPartialEq for FileId