Struct Resource 

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

A normalised forge-qualified resource: github.com/acme or github.com/acme/widgets.

Construction always goes through the vgi_core grammar, so a Resource in hand is lowercased, names its forge, and has no empty or dot segments. It serialises as its string form and deserialisation re-validates, so a bridge job cannot smuggle an unnormalised one in.

Implementations

impl Resource

pub fn parse(raw: &str) -> Result<Self>

Parse and normalise any forge-qualified resource (any depth the grammar allows). Use Resource::parse_owner_repo when the forge is GitHub or Forgejo.

pub fn parse_owner_repo(raw: &str) -> Result<Self>

Parse a resource on an owner[/repo] forge (GitHub, Forgejo).

On top of the shared grammar this refuses a .git suffix on the repo segment: neither forge lets a repository be named that way, so it can only be a clone URL pasted in the wrong place.

pub fn require_owner_repo(&self) -> Result<()>

Check that this is exactly host/owner/repo under the owner/repo grammar. A Resource that arrived by deserialisation was validated against the general grammar only (any depth), so an adapter for an owner/repo forge must call this before splitting it into owner and name — github.com/acme/evil/widgets is not acme/widgets.

pub fn namespace_of(host: &str, owner: &str) -> Result<Self>

Build host/owner from parts, validating the result.

pub fn as_str(&self) -> &str

The canonical string.

pub fn host(&self) -> &str

The forge host, e.g. github.com.

pub fn path_segments(&self) -> impl Iterator<Item = &str>

Path segments after the host.

pub fn owner(&self) -> &str

The first path segment: the owner (org or user).

pub fn repo_name(&self) -> Option<&str>

The last path segment when the resource names a repository (more than one path segment); None for a namespace.

pub fn is_namespace(&self) -> bool

Whether this is a namespace (host/owner) rather than a repository.

pub fn namespace(&self) -> Resource

The namespace this resource sits in (host/owner); itself when it is one.

pub fn join(&self, name: &str) -> Result<Resource>

A repository under this namespace. Fails if self is not a namespace or name is not a valid repo segment.

pub fn contains(&self, other: &Resource) -> bool

Segment-prefix containment (§4.2 scope check): a namespace contains its repositories, never another owner’s, never another forge’s.

Trait Implementations

impl AsRef<str> for Resource

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Resource

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 Resource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Resource

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Resource

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

Formats the value using the given formatter.

impl Eq for Resource

impl FromStr for Resource

type Err = ForgeError

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 Resource

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 Resource

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 Resource

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Resource

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 Resource

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Resource