Struct Github 

pub struct Github<'a> { /* private fields */ }

The Github repository and the Url to the files in the repository.

Implementations

impl<'a> Github<'a>

pub fn new( owner: &'a str, repo: &'a str, branch: &'a str, path: &'a str, file: &'a str, ) -> Github<'a>

Creates a new instance with empty strings.

pub fn get_url(&self) -> String

Gets the built url of the GitHub instance.

pub fn build_url(&mut self)

Builds the Url for the raw contents of a file.

This function should only be used for files on Github which can be opened in raw format.

Usage

let mut github_repo = Github::new("OneilNvM", "rl-hours-tracker", "master", "src", "main.rs");

// Example Output: "https://raw.githubusercontent.com/OneilNvM/rl-hours-tracker/refs/heads/master/src/main.rs"
github_repo.build_url();

pub fn build_image_url(&mut self)

Builds the Url for the blob of an image file.

This function should only be used for image files in a Github repository.

Usage

let mut github_repo = Github::new("OneilNvM", "rl-hours-tracker", "master", "images", "img.png");

// Example Output: "https://github.com/OneilNvM/rl-hours-tracker/blob/master/images/img.png"
github_repo.build_image_url();

Trait Implementations

impl<'a> Clone for Github<'a>

fn clone(&self) -> Github<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Github<'a>

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

Formats the value using the given formatter.