Struct CheckoutId 

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

One checkout of a repository: the primary one, or one linked worktree of it.

crate::repository::identity’s digest of the checkout root — the value this executable’s lease, index and server already key a checkout by. Two worktrees of one repository share a RepositoryId and differ here, which is the distinction the continuity resolver’s first tier is made of: a record from another worktree is never silently offered as your context.

use majordomus_cli::session::{CheckoutId, RepositoryId};
use std::path::Path;

let a = CheckoutId::of(Path::new("/a/b"));
let b = CheckoutId::of(Path::new("/a/c"));
assert_ne!(a, b, "two checkouts");
assert_eq!(a, CheckoutId::of(Path::new("/a/b")), "the same checkout across runs");
assert!(!a.as_str().contains('/'), "a digest, never a path");

// and the two identities are not interchangeable: this does not compile.
// let _: RepositoryId = a;
let _ = RepositoryId::recorded("unused");

Implementations

impl CheckoutId

pub fn of(root: &Path) -> Self

The checkout rooted at root. Total: a path that does not exist still has an identity, because the question “which checkout is this record about” has to be answerable for a record written on a disk that has since been unmounted.

use majordomus_cli::session::CheckoutId;
use std::path::Path;
let gone = CheckoutId::of(Path::new("/Volumes/unmounted/repo"));
assert_eq!(gone.as_str().len(), 32, "a path that does not exist still has one");

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

A value read back from a record that carries one. Whatever the store wrote is accepted: a record written by an older version of the tool carries an older spelling, and refusing it would lose the record.

use majordomus_cli::session::CheckoutId;
use std::path::Path;
// a record's own string is taken as it stands, never made to agree with a digest
assert_ne!(CheckoutId::recorded("2b0f1c8e9a774d31"), CheckoutId::of(Path::new("/a/b")));

pub fn as_str(&self) -> &str

The value as text: what a shared record writes as worktree_id:. It is never compared with a repository identity, which is a different question with a different answer.

use majordomus_cli::session::CheckoutId;
assert_eq!(CheckoutId::recorded("2b0f1c8e").as_str(), "2b0f1c8e");

Trait Implementations

impl Clone for CheckoutId

fn clone(&self) -> CheckoutId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckoutId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CheckoutId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CheckoutId

impl Hash for CheckoutId

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 JsonSchema for CheckoutId

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for CheckoutId

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

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

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

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 CheckoutId