Struct octorust::licenses::Licenses

pub struct Licenses { /* fields omitted */ }

Implementations

impl Licenses

pub async fn get_all_commonly_used(
    &self,
    featured: bool,
    per_page: i64,
    page: i64
) -> Result<Vec<LicenseSimple>>

Get all commonly used licenses.

This function performs a GET to the /licenses endpoint.

FROM: https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses

Parameters:

• featured: bool
• per_page: i64 – Results per page (max 100).
• page: i64 – Page number of the results to fetch.

pub async fn get_all_all_commonly_used(
    &self,
    featured: bool
) -> Result<Vec<LicenseSimple>>

Get all commonly used licenses.

This function performs a GET to the /licenses endpoint.

As opposed to get_all_commonly_used, this function returns all the pages of the request at once.

FROM: https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses

pub async fn get(&self, license: &str) -> Result<LicenseData>

Get a license.

This function performs a GET to the /licenses/{license} endpoint.

FROM: https://docs.github.com/rest/reference/licenses#get-a-license

Parameters:

• license: &str

pub async fn get_for_repo(
    &self,
    owner: &str,
    repo: &str
) -> Result<LicenseContent>

Get the license for a repository.

This function performs a GET to the /repos/{owner}/{repo}/license endpoint.

This method returns the contents of the repository’s license file, if one is detected.

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

FROM: https://docs.github.com/rest/reference/licenses/#get-the-license-for-a-repository

Parameters:

• owner: &str
• repo: &str