Struct GithubRef 

pub struct GithubRef { /* private fields */ }

A GitHub repository, optionally at a tag. The fields are private: only GithubRef::parse makes one from outside this module, so the owner, repository and tag always passed its checks before they are joined onto an API path (#649 review).

Implementations

impl GithubRef

pub fn owner(&self) -> &str

Repository owner.

pub fn repo(&self) -> &str

Repository name.

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

The release tag, when the URL named one.

pub fn parse(input: &str) -> Option<Self>

Parse https://github.com/{owner}/{repo}, optionally followed by /releases/tag/{tag} or /tree/{tag}. None for anything else, including other hosts and non-repository GitHub pages.

pub fn html_url(&self) -> String

The page a reader follows: the release when there is a tag, else the repository.

pub fn default_key(&self) -> String

A citation key when no template or --key gives one: {repo}_{tag} reduced to what every BibTeX processor accepts.

Trait Implementations

impl Clone for GithubRef

fn clone(&self) -> GithubRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GithubRef

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

Formats the value using the given formatter.

impl Eq for GithubRef

impl PartialEq for GithubRef

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