Struct LocalFileIdentifier

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

Local file type

This type is used to identify an opened file in a file system. It is used for the file identification between the file system and the virtual file system. It is a wrapper around a tuple of TaskIdentifier and FileIdentifier. It is unique from the file system point of view.

Example

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

use task::TaskIdentifier;

let Identifier = Local_file_identifier_type::new(
    TaskIdentifier::from(0x1234),
    File_identifier_type::from(0x5678),
);

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

assert_eq!(Task, TaskIdentifier::from(0x1234));
assert_eq!(File, File_identifier_type::from(0x5678));

let Minimum = Local_file_identifier_type::get_minimum(Task);
assert_eq!(Minimum, Local_file_identifier_type::new(Task, File_identifier_type::Minimum));

let Maximum = Local_file_identifier_type::get_maximum(Task);
assert_eq!(Maximum, Local_file_identifier_type::new(Task, File_identifier_type::Maximum));

let (Task, Unique_file_identifier) = Identifier.Into_unique_file_identifier(File_system_identifier_type::from(0x9ABC));

assert_eq!(Task, TaskIdentifier::from(0x1234));
assert_eq!(Unique_file_identifier, Unique_file_identifier_type::new(File_system_identifier_type::from(0x9ABC), File_identifier_type::from(0x5678)));

Implementations

impl LocalFileIdentifier

pub const fn new(task: TaskIdentifier, file: FileIdentifier) -> Self

pub const fn split(self) -> (TaskIdentifier, FileIdentifier)

pub const fn get_minimum(task: TaskIdentifier) -> Self

pub const fn get_maximum(task: TaskIdentifier) -> Self

pub const fn into_unique_file_identifier( self, file_system: FileSystemIdentifier, ) -> (TaskIdentifier, UniqueFileIdentifier)

pub const fn into_inner(self) -> usize

Trait Implementations

impl Add<usize> for LocalFileIdentifier

type Output = LocalFileIdentifier

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl AddAssign<usize> for LocalFileIdentifier

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for LocalFileIdentifier

fn clone(&self) -> LocalFileIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalFileIdentifier

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

Formats the value using the given formatter.

impl Hash for LocalFileIdentifier

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 IntoIterator for LocalFileIdentifier

type Item = LocalFileIdentifier

The type of the elements being iterated over.

type IntoIter = LocalFileIdentifierIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for LocalFileIdentifier

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

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

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

impl Eq for LocalFileIdentifier

impl StructuralPartialEq for LocalFileIdentifier