Struct RepositoryId 

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

A git repository, named without naming a disk.

The value is crate::repository::git_identity’s digest of the git directory every work tree shares: one value for the primary checkout and every linked worktree of it, a different value for a different repository, and never a path — a shared record that carried the path would disclose where somebody keeps their work, which is of no use to a reader and of some use to somebody else (ADR 0014).

use majordomus_cli::session::RepositoryId;
use std::process::Command;

let dir = tempfile::tempdir().unwrap();
let root = dir.path().join("repo");
std::fs::create_dir_all(&root).unwrap();
let git = |args: &[&str]| assert!(
    Command::new("git").arg("-C").arg(&root).args(args).status().unwrap().success()
);
git(&["init", "-q", "."]);
git(&["-c", "user.email=t@e.x", "-c", "user.name=t", "commit", "-q", "--allow-empty", "-m", "i"]);
let wt = dir.path().join("repo-wt");
git(&["worktree", "add", "-q", "-b", "feature/x", wt.to_str().unwrap()]);

let here = RepositoryId::of(&root).expect("a work tree");
let there = RepositoryId::of(&wt).expect("a linked work tree");
assert_eq!(here, there, "one repository, two checkouts");
assert!(!here.as_str().contains('/'), "a digest, never a path");

Implementations

impl RepositoryId

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

The repository the checkout at root belongs to. None where git cannot be asked: a repository of the layer does not have to be version controlled, and saying so is better than inventing an identity for one that is not.

use majordomus_cli::session::RepositoryId;
// absence is an answer: a plain directory belongs to no repository, and saying so is
// better than minting an identity nothing could ever match
let plain = tempfile::tempdir().unwrap();
assert!(RepositoryId::of(plain.path()).is_none());

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

A value read back from a record that already carries one.

It takes whatever the store wrote, because a store written by an older version of the tool carries an older spelling and refusing to read it would lose the record. What this type guarantees is not the shape of the string; it is that the string is never passed where a checkout, an episode or a provider session is wanted.

use majordomus_cli::session::RepositoryId;
let recorded = RepositoryId::recorded("git@github.com:korczis/prismatic-majordomus.git");
assert_eq!(recorded.as_str(), "git@github.com:korczis/prismatic-majordomus.git");

pub fn as_str(&self) -> &str

The value as text: what a record writes down. It is never parsed back into a checkout, an episode or a provider identity.

use majordomus_cli::session::RepositoryId;
assert_eq!(RepositoryId::recorded("origin-url").as_str(), "origin-url");

Trait Implementations

impl Clone for RepositoryId

fn clone(&self) -> RepositoryId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepositoryId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RepositoryId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RepositoryId

impl Hash for RepositoryId

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 RepositoryId

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 RepositoryId

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

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

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

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 RepositoryId