Struct GithubSpec 

pub struct GithubSpec {
    pub owner: CompactString,
    pub repo: CompactString,
    pub ref_name: CompactString,
    pub subdir: CompactString,
}

A parsed GitHub repository reference: {owner, repo, ref, subdir}.

Two spellings normalize here, so every consumer shares one parser:

• the URL form: https://github.com/owner/repo[/tree/ref[/subdir…]] (e.g. https://github.com/example-org/docs-site/tree/main/stacks);
• the ref grammar: github:owner/repo@ref[//subdir].

A bare repo (no ref) leaves GithubSpec::ref_name empty; the source resolves it to the repository’s default branch with one extra API call.

Known limitation of the URL form: GitHub’s own URLs cannot distinguish a branch name containing / from the start of a path, so the first segment after /tree/ is taken as the ref. Branches like feat/x need the ref grammar, where @ref//subdir is unambiguous.

Fields

owner: CompactString

Repository owner (user or organization).

repo: CompactString

Repository name.

ref_name: CompactString

Branch, tag, or commit SHA; empty = the repository’s default branch.

subdir: CompactString

Subdirectory to index (“” = the whole repository).

Implementations

impl GithubSpec

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

Parse either spelling. See the type docs for the accepted forms.

pub fn matches(s: &str) -> bool

Whether s looks like a GitHub spec at all (cheap, no allocation). Callers use this to route between the crawler and this source.

Trait Implementations

impl Clone for GithubSpec

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 GithubSpec

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

Formats the value using the given formatter.

impl Eq for GithubSpec

impl PartialEq for GithubSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GithubSpec