Struct UniqueFileIdentifier

pub struct UniqueFileIdentifier(/* private fields */);

Unique file identifier type

This type is used to identify an opened file in the virtual file system. It is used for the file identification between the virtual file system and the outside world. It is similar to a file descriptor in Unix-like systems. It is a wrapper around a tuple of FileSystemIdentifier and FileIdentifier. It is unique from the virtual file system point of view.

Example

use file_system::{Unique_file_identifier_type, File_identifier_type, File_system_identifier_type, Local_file_identifier_type};

use task::TaskIdentifier;

let Identifier = Unique_file_identifier_type::new(
    File_system_identifier_type::from(0x1234),
    File_identifier_type::from(0x5678),
);

let (File_system, File) = Identifier.Split();

assert_eq!(File_system, File_system_identifier_type::from(0x1234));
assert_eq!(File, File_identifier_type::from(0x5678));

let (File_system, Local_file) = Identifier.Into_local_file_identifier(TaskIdentifier::from(0x9ABC));

assert_eq!(File_system, File_system_identifier_type::from(0x1234));
assert_eq!(Local_file, Local_file_identifier_type::new(TaskIdentifier::from(0x9ABC), File_identifier_type::from(0x5678)));

Implementations

impl UniqueFileIdentifier

pub const fn new( file_system: FileSystemIdentifier, file: FileIdentifier, ) -> Self

pub const fn split(&self) -> (FileSystemIdentifier, FileIdentifier)

pub const fn into_local_file_identifier( self, task: TaskIdentifier, ) -> (FileSystemIdentifier, LocalFileIdentifier)

pub const fn into_inner(self) -> usize

pub const fn from_raw(inner: usize) -> Self

This function is shouldn’t be used because it doesn’t check the validity of the file identifier.

Trait Implementations

impl Clone for UniqueFileIdentifier

fn clone(&self) -> UniqueFileIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UniqueFileIdentifier

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

Formats the value using the given formatter.

impl From<UniqueFileIdentifier> for usize

fn from(identifier: UniqueFileIdentifier) -> Self

Converts to this type from the input type.

impl From<usize> for UniqueFileIdentifier

fn from(identifier: usize) -> Self

Converts to this type from the input type.

impl Hash for UniqueFileIdentifier

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 UniqueFileIdentifier

fn cmp(&self, other: &UniqueFileIdentifier) -> 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 UniqueFileIdentifier

fn eq(&self, other: &UniqueFileIdentifier) -> 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 UniqueFileIdentifier

fn partial_cmp(&self, other: &UniqueFileIdentifier) -> 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 UniqueFileIdentifier

impl Eq for UniqueFileIdentifier

impl StructuralPartialEq for UniqueFileIdentifier