Struct SyntheticFrontierName 

pub struct SyntheticFrontierName { /* private fields */ }

Type-distinct name of a synthetic frontier root.

This is not a ThreadName and not a [MarkerName]. Consume, store, and mirror sites must persist it through the synthetic-ref path.

Implementations

impl SyntheticFrontierName

pub fn new( thread: impl AsRef<str>, change_id: ChangeId, ) -> Result<SyntheticFrontierName, SyntheticFrontierNameError>

Build a synthetic root for thread at change_id.

thread is the user thread whose sibling line this root names. It must itself be a user name (not heddle/-rooted).

pub fn parse( name: &str, ) -> Result<SyntheticFrontierName, SyntheticFrontierNameError>

Parse a wire/store name of the form heddle/frontier/<thread>/<full-changeid>.

The last /-segment is the ChangeId (hc- + full Crockford base32). Everything between heddle/frontier/ and that segment is the thread name, which may itself contain /.

pub fn looks_like(name: &str) -> bool

True when name is a well-formed synthetic frontier root.

pub fn thread(&self) -> &str

pub fn change_id(&self) -> ChangeId

pub fn as_name(&self) -> String

Wire / local-store name: heddle/frontier/<thread>/<full-changeid>.

pub fn git_ref(&self) -> String

Git-side name: refs/heddle/frontier/<thread>/<full-changeid>.

pub fn owning_thread(&self) -> ThreadName

The user thread this synthetic root belongs to, as a ThreadName.

Only the owning user thread is a ThreadName. The synthetic root itself must never be coerced into one.

Trait Implementations

impl Clone for SyntheticFrontierName

fn clone(&self) -> SyntheticFrontierName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntheticFrontierName

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

Formats the value using the given formatter.

impl Display for SyntheticFrontierName

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

Formats the value using the given formatter.

impl Eq for SyntheticFrontierName

impl Hash for SyntheticFrontierName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 SyntheticFrontierName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SyntheticFrontierName

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