Struct FileIdentifier

Source
pub struct FileIdentifier(/* private fields */);
Expand description

Type-safe wrapper for file identifiers.

File identifiers are used to reference opened files within a task’s context, similar to file descriptors in Unix-like systems. Each task maintains its own file identifier space, allowing for task isolation and security.

§Standard File Identifiers

The following standard identifiers are predefined:

§Examples

use file_system::File_identifier_type;

// Standard file identifiers
assert_eq!(File_identifier_type::Standard_in.Into_inner(), 0);
assert_eq!(File_identifier_type::Standard_out.Into_inner(), 1);
assert_eq!(File_identifier_type::Standard_error.Into_inner(), 2);

// Create a custom file identifier
let file_id = File_identifier_type::new(42);
assert_eq!(file_id.Into_inner(), 42);

Implementations§

Source§

impl FileIdentifier

Source

pub const SIZE_BITS: u8 = 32u8

Size in bits of the underlying identifier type.

Source

pub const STANDARD_IN: FileIdentifier

Standard input file identifier (traditionally 0).

Source

pub const STANDARD_OUT: FileIdentifier

Standard output file identifier (traditionally 1).

Source

pub const STANDARD_ERROR: FileIdentifier

Standard error file identifier (traditionally 2).

Source

pub const MINIMUM: FileIdentifier

Minimum file identifier available for regular files.

Regular files should use identifiers starting from this value to avoid conflicts with standard file identifiers.

Source

pub const MAXIMUM: FileIdentifier

Maximum possible file identifier value.

Source

pub const fn new(identifier: FileIdentifierInner) -> Self

Create a new file identifier from a raw value.

§Arguments
  • Identifier - The raw identifier value
§Examples
use file_system::File_identifier_type;

let file_id = File_identifier_type::new(5);
assert_eq!(file_id.Into_inner(), 5);
Source

pub const fn into_inner(self) -> FileIdentifierInner

Get the raw identifier value.

§Returns

The underlying raw identifier value.

§Examples
use file_system::File_identifier_type;

let file_id = File_identifier_type::new(42);
assert_eq!(file_id.Into_inner(), 42);

Trait Implementations§

Source§

impl Clone for FileIdentifier

Source§

fn clone(&self) -> FileIdentifier

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileIdentifier

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<FileIdentifier> for FileIdentifierInner

Source§

fn from(internal_file_identifier: FileIdentifier) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for FileIdentifier

Source§

fn from(internal_file_identifier: FileIdentifierInner) -> Self

Converts to this type from the input type.
Source§

impl Hash for FileIdentifier

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for FileIdentifier

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for FileIdentifier

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for FileIdentifier

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Copy for FileIdentifier

Source§

impl Eq for FileIdentifier

Source§

impl StructuralPartialEq for FileIdentifier

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.