Struct ItemId 

pub struct ItemId { /* private fields */ }

Identifier used to select a tracked item by name and index.

Use this when:

• you know the shared name and want the first match (ItemId::id("name")),
• or when you need a specific duplicate (ItemId::with_index("name", i)).

ItemId::database_id() is special and points to the database root itself.

Examples

use file_database::ItemId;

let first = ItemId::id("report.txt");
let second = ItemId::with_index("report.txt", 1);
let root = ItemId::database_id();

assert_eq!(first.get_name(), "report.txt");
assert_eq!(first.get_index(), 0);
assert_eq!(second.get_index(), 1);
assert_eq!(root.get_name(), "");

Implementations

impl ItemId

pub fn database_id() -> Self

Returns the ItemId::database_id() for the database itself.

Examples

use file_database::ItemId;

let root = ItemId::database_id();
assert_eq!(root.get_name(), "");
assert_eq!(root.get_index(), 0);

pub fn id(id: impl Into<String>) -> Self

Creates an ItemId with index 0.

Parameters

• id: shared name key stored in the manager.

Examples

use file_database::ItemId;

let id = ItemId::id("file.txt");
assert_eq!(id.get_name(), "file.txt");
assert_eq!(id.get_index(), 0);

pub fn with_index(id: impl Into<String>, index: usize) -> Self

Creates an ItemId with an explicit index.

Parameters

• id: shared name key.
• index: caller-defined unique number used as part of identity.

Examples

use file_database::ItemId;

let id = ItemId::with_index("file.txt", 2);
assert_eq!(id.get_name(), "file.txt");
assert_eq!(id.get_index(), 2);

pub fn from(id: impl Into<String>, index: usize) -> Self

Creates an ItemId from name and index.

Parameters

• id: shared name key.
• index: caller-defined unique number used as part of identity.

pub fn get_name(&self) -> &str

Returns the shared name of this ItemId.

pub fn get_index(&self) -> usize

Returns the zero-based index for this shared name.

pub fn as_str(&self) -> &str

Returns the shared name as &str.

pub fn as_string(&self) -> String

Returns an owned String containing this ItemId’s shared name.

Trait Implementations

impl Clone for ItemId

fn clone(&self) -> ItemId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemId

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

Formats the value using the given formatter.

impl From<&ItemId> for ItemId

fn from(value: &ItemId) -> Self

Clones an ItemId from a reference.

impl<T> From<T> for ItemId

where T: Into<String>,

fn from(value: T) -> Self

Creates an ItemId from a name, defaulting index to 0.

impl Hash for ItemId

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 ItemId

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

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

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

impl StructuralPartialEq for ItemId