Struct CanonicalRepoName 

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

A GitHub owner/repo in the canonical casing GitHub reports for the repository.

GitHub resolves repository names case-insensitively, but OSV.dev’s GitHub Actions package names are exact-case, so a uses: value written in another casing only matches advisories once mapped to this spelling. Constructible only from a GitHub API URL the server itself returned, never from user-written text.

Examples

use deps_core::github::CanonicalRepoName;

let name = CanonicalRepoName::from_commit_url(
    "https://api.github.com/repos/Azure/setup-kubectl/commits/0123abcd",
)
.unwrap();
assert_eq!(name.as_str(), "Azure/setup-kubectl");
assert!(CanonicalRepoName::from_commit_url("").is_none());

Implementations

impl CanonicalRepoName

pub fn from_commit_url(url: &str) -> Option<Self>

Extracts the repository from a .../repos/{owner}/{repo}/commits/{sha} API URL.

Returns None when url has no such shape or the owner/repo fails validate_owner_repo.

pub fn as_str(&self) -> &str

The owner/repo string in canonical casing.

Trait Implementations

impl Clone for CanonicalRepoName

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 CanonicalRepoName

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

Formats the value using the given formatter.

impl Eq for CanonicalRepoName

impl Hash for CanonicalRepoName

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 PartialEq for CanonicalRepoName

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CanonicalRepoName