Struct RepoRef 

pub struct RepoRef { /* private fields */ }

A validated repository reference: a namespace and a name, and nothing else.

The only ways to obtain one are resolve_repo_path and RepoRef::new, both of which validate. There is no constructor that takes a string unchecked outside of [red], which exists to prove the checks bite.

Implementations

impl RepoRef

pub fn new(namespace: &str, name: &str) -> Result<Self>

Validate a namespace and a repository name and pair them up.

The namespace may itself be nested (team/sub); every level is validated by the same rules as the repository name.

pub fn namespace(&self) -> &str

The namespace, possibly nested (team/sub).

pub fn name(&self) -> &str

The repository name, without any .git suffix.

pub fn key(&self) -> String

The catalog key, <namespace>/<repo>. Stable, and the only identifier the catalog stores.

pub fn to_ssh_path(&self) -> String

The path as a client would write it after the colon: <namespace>/<repo>.git.

pub fn path_under(&self, root: &Path) -> Result<PathBuf>

Where this repository’s directory lives under root, checked against symlink escapes.

The string checks in resolve_repo_path cannot see a symlink: ns may be a perfectly ordinary-looking name that happens to be a link to /etc. So the deepest existing ancestor of the target is canonicalised and asserted to still be inside the canonicalised root.

This is for the fs backend only. The appliance has no filesystem and never calls it.

Trait Implementations

impl Clone for RepoRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepoRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RepoRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RepoRef

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

Formats the value using the given formatter.

impl Eq for RepoRef

impl FromStr for RepoRef

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for RepoRef

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 RepoRef

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RepoRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RepoRef

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

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 RepoRef