Struct ItemId 

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

A validated work-item identifier (e.g. bn-a7x, bn-a7x.1).

The inner string is guaranteed to be a valid terseid ID with the bn prefix. Construction goes through FromStr, ItemId::new_unchecked, or the generator helpers.

Implementations

impl ItemId

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

Create an ItemId without validation.

Safety (logical)

The caller must ensure raw is a valid terseid ID with the correct prefix. Prefer FromStr or the generator helpers in production code.

pub fn parse(raw: &str) -> Result<Self, ItemIdError>

Parse and validate a raw string into an ItemId.

The string is lower-cased and trimmed before validation.

Errors

Returns ItemIdError::InvalidFormat if the format is wrong, or ItemIdError::WrongPrefix if the prefix is not bn.

pub fn parse_any_prefix(raw: &str) -> Result<Self, ItemIdError>

Parse any valid terseid ID regardless of prefix.

Used by the event parser and migration paths where IDs from external systems (e.g. beads with custom prefixes) must be accepted.

Errors

Returns ItemIdError::InvalidFormat if the string is not a valid terseid ID.

pub fn as_str(&self) -> &str

Return the raw ID string.

pub fn parsed(&self) -> ParsedId

Parse the inner string into a terseid ParsedId.

This never fails because ItemId guarantees validity at construction.

Panics

Panics if the internal invariant is broken (the stored string is not a valid terseid ID). This should never happen through the public API.

pub fn is_root(&self) -> bool

Return true if this is a root ID (no child path segments).

pub fn is_child(&self) -> bool

Return true if this is a child ID (has child path segments).

pub fn depth(&self) -> usize

Depth of the child path (0 for root IDs).

pub fn child(&self, number: u32) -> Self

Create a child ID by appending a child number.

let parent = ItemId::parse("bn-a7x").unwrap();
let child = parent.child(1);
assert_eq!(child.as_str(), "bn-a7x.1");

pub fn parent(&self) -> Option<Self>

Return the parent ItemId, or None if this is a root.

pub fn is_child_of(&self, ancestor: &Self) -> bool

Return true if self is a descendant of ancestor.

Trait Implementations

impl AsRef<str> for ItemId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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<'de> Deserialize<'de> for ItemId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ItemId

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

Formats the value using the given formatter.

impl From<ItemId> for String

fn from(id: ItemId) -> Self

Converts to this type from the input type.

impl FromStr for ItemId

type Err = ItemIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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 Serialize for ItemId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for ItemId

type Error = ItemIdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for ItemId

impl StructuralPartialEq for ItemId