Struct Inode

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

Type-safe wrapper for inode numbers.

An inode (index node) is a unique identifier for file system objects such as files, directories, symbolic links, and other entities within a file system. Each file system object has a unique inode number that persists for the lifetime of the object.

Examples

use file_system::Inode_type;

// Create an inode number
let inode = Inode_type::new(42);
assert_eq!(inode.As_u64(), 42);

// Inode numbers can be compared
let another_inode = Inode_type::new(43);
assert!(inode < another_inode);

// Arithmetic operations are supported
let incremented = inode + 10;
assert_eq!(incremented.As_u64(), 52);

Note

Inode 0 is typically reserved in most file systems. The minimum valid inode number is provided as Inode::MINIMUM.

Implementations

impl Inode

pub const MINIMUM: Self

The minimum valid inode number.

Most file systems reserve inode 0 for special purposes, so valid inode numbers typically start from 1.

pub const fn new(item: u64) -> Self

Create a new inode identifier from a u64 value.

Arguments

• Item - The inode number

Examples

use file_system::Inode_type;

let inode = Inode_type::new(123);
assert_eq!(inode.As_u64(), 123);

pub const fn as_u64(self) -> u64

Get the inode number as a u64.

Returns

The underlying inode number as a 64-bit unsigned integer.

Examples

use file_system::Inode_type;

let inode = Inode_type::new(456);
assert_eq!(inode.As_u64(), 456);

Trait Implementations

impl Add<u64> for Inode

type Output = Inode

The resulting type after applying the + operator.

fn add(self, other: u64) -> Self

Performs the + operation.

impl AddAssign<u64> for Inode

fn add_assign(&mut self, other: u64)

Performs the += operation.

impl Clone for Inode

fn clone(&self) -> Inode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Inode

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

Formats the value using the given formatter.

impl From<Inode> for u64

fn from(item: Inode) -> Self

Converts to this type from the input type.

impl From<u64> for Inode

fn from(item: u64) -> Self

Converts to this type from the input type.

impl Ord for Inode

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

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

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

impl Eq for Inode

impl StructuralPartialEq for Inode