Struct Local_file_identifier_type

pub struct Local_file_identifier_type(/* 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 Task_identifier_type and File_identifier_type. 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::Task_identifier_type;

let Identifier = Local_file_identifier_type::New(
    Task_identifier_type::from(0x1234),
    File_identifier_type::from(0x5678),
);

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

assert_eq!(Task, Task_identifier_type::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, Task_identifier_type::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 Local_file_identifier_type

pub const fn New(Task: Task_identifier_type, File: File_identifier_type) -> Self

pub const fn Split(self) -> (Task_identifier_type, File_identifier_type)

pub const fn Get_minimum(Task: Task_identifier_type) -> Self

pub const fn Get_maximum(Task: Task_identifier_type) -> Self

pub const fn Into_unique_file_identifier( self, File_system: File_system_identifier_type, ) -> (Task_identifier_type, Unique_file_identifier_type)

pub const fn Into_inner(self) -> usize

Trait Implementations

impl Add<usize> for Local_file_identifier_type

type Output = Local_file_identifier_type

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for Local_file_identifier_type

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for Local_file_identifier_type

fn clone(&self) -> Local_file_identifier_type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Local_file_identifier_type

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

Formats the value using the given formatter.

impl Hash for Local_file_identifier_type

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 Local_file_identifier_type

type Item = Local_file_identifier_type

The type of the elements being iterated over.

type IntoIter = Local_file_identifier_iterator_type

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Local_file_identifier_type

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

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

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

impl Eq for Local_file_identifier_type

impl StructuralPartialEq for Local_file_identifier_type