Struct GitHubRepoFilePath

pub struct GitHubRepoFilePath { /* private fields */ }

A FilePath for a file hosted in a GitHub repository with a specified ref.

Implementations

impl GitHubRepoFilePath

pub fn new(repo_id: &str, git_ref: &str) -> Self

pub fn repo_id(&self) -> &str

Return the repository ID.

pub fn git_ref(&self) -> &str

Return the Git ref.

pub fn path(&self) -> &str

Return the path of the file in the GitHub repository.

pub fn join(&self, file: &str) -> Result<Self>

pub fn default_download_url(&self) -> Result<Url>

Return the default download URL, without a token.

This URL can only be used to download files from public repositories.

Otherwise, the URL must be retrieved via the GitHub repository contents API.

pub fn contents_api_url(&self) -> Result<Url>

Trait Implementations

impl Clone for GitHubRepoFilePath

fn clone(&self) -> GitHubRepoFilePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GitHubRepoFilePath

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

Formats the value using the given formatter.