Struct WorktreeId 

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

An identifier for one checkout, used as the last component of a layer key.

It is an opaque token rather than a path on purpose: a layer key is stored and printed, and a local filesystem path is user-identifying data that has no business in a record. Producers derive it however they like (a digest of the canonical worktree path is the obvious choice); this type only guarantees the token is well-formed, so a layer key can never be ambiguous.

Implementations

impl WorktreeId

pub fn new(raw: &str) -> Result<Self, FindingsError>

Validate and wrap a worktree id: 1..=64 characters of [a-z0-9-].

Errors

Returns FindingsError::InvalidWorktreeId if raw is empty, too long, or contains anything else.

pub fn as_str(&self) -> &str

The token.

Trait Implementations

impl Clone for WorktreeId

fn clone(&self) -> WorktreeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeId

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

Formats the value using the given formatter.

impl Display for WorktreeId

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

Formats the value using the given formatter.

impl Eq for WorktreeId

impl Ord for WorktreeId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WorktreeId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorktreeId