Struct FileIdentifier 

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

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:

• FileIdentifier::STANDARD_IN (0) - Standard input
• FileIdentifier::STANDARD_OUT (1) - Standard output
• FileIdentifier::STANDARD_ERROR (2) - Standard error

Examples

use abi_context::FileIdentifier;

// Standard file identifiers
assert_eq!(1u16, FileIdentifier::STANDARD_IN.into());
assert_eq!(2u16, FileIdentifier::STANDARD_OUT.into());
assert_eq!(3u16, FileIdentifier::STANDARD_ERROR.into());

// Create a custom file identifier
let file_id = FileIdentifier::new(42).unwrap();
assert_eq!(42u16, file_id.into());

Implementations

impl FileIdentifier

pub const SIZE_BITS: u8

Size in bits of the underlying identifier type.

pub const STANDARD_IN: Self

Standard input file identifier (traditionally 0).

pub const STANDARD_OUT: Self

Standard output file identifier (traditionally 1).

pub const STANDARD_ERROR: Self

Standard error file identifier (traditionally 2).

pub const MINIMUM_FILE: Self

Minimum file identifier available for regular files.

Regular files should use identifiers starting from this value to avoid conflicts with internal or reserved identifiers.

pub const MAXIMUM_FILE: Self

Maximum possible file identifier value.

pub const MINIMUM_DIRECTORY: Self

pub const MAXIMUM_DIRECTORY: Self

pub const fn new(identifier: u16) -> Option<Self>

Create a new file identifier from a raw value.

Arguments

• Identifier - The raw identifier value.

pub const fn new_panic(identifier: u16) -> Self

pub const fn into_inner(self) -> FileIdentifierInner

Get the raw identifier value.

Returns

The underlying raw identifier value.

pub const fn into_unique(self, task: TaskIdentifier) -> UniqueFileIdentifier

pub const fn is_directory(self) -> bool

Trait Implementations

impl Clone for FileIdentifier

fn clone(&self) -> FileIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileIdentifier

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

Formats the value using the given formatter.

impl From<FileIdentifier> for u16

fn from(file_identifier: FileIdentifier) -> Self

Converts to this type from the input type.

impl Hash for FileIdentifier

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 FileIdentifier

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

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

fn partial_cmp(&self, other: &FileIdentifier) -> 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 TryFrom<u16> for FileIdentifier

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FileIdentifier

impl Eq for FileIdentifier

impl StructuralPartialEq for FileIdentifier