Struct roctogen::endpoints::licenses::Licenses

pub struct Licenses<'api> { /* fields omitted */ }

Implementations

impl<'api> Licenses<'api>

pub async fn get_async(
    &self,
    license: &str
) -> Result<License, LicensesGetError>

---

Get a license

GitHub API docs for get

---

pub fn get(&self, license: &str) -> Result<License, LicensesGetError>

---

Get a license

GitHub API docs for get

---

pub async fn get_all_commonly_used_async(
    &self,
    query_params: Option<impl Into<LicensesGetAllCommonlyUsedParams>>
) -> Result<Vec<LicenseSimple>, LicensesGetAllCommonlyUsedError>

---

Get all commonly used licenses

GitHub API docs for get_all_commonly_used

---

pub fn get_all_commonly_used(
    &self,
    query_params: Option<impl Into<LicensesGetAllCommonlyUsedParams>>
) -> Result<Vec<LicenseSimple>, LicensesGetAllCommonlyUsedError>

---

Get all commonly used licenses

GitHub API docs for get_all_commonly_used

---

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

---

Get the license for a repository

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.

GitHub API docs for get_for_repo

---

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

---

Get the license for a repository

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.

GitHub API docs for get_for_repo

---