Struct octorust::codes_of_conduct::CodesOfConduct

pub struct CodesOfConduct {
    pub client: Client,
}

Fields

client: Client

Implementations

impl CodesOfConduct

pub async fn get_all_codes_of_conduct(&self) -> Result<Vec<CodeOfConduct>>

Get all codes of conduct.

This function performs a GET to the /codes_of_conduct endpoint.

FROM: https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct

pub async fn get_all_all_codes_of_conduct(&self) -> Result<Vec<CodeOfConduct>>

Get all codes of conduct.

This function performs a GET to the /codes_of_conduct endpoint.

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

FROM: https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct

pub async fn get_conduct_code(&self, key: &str) -> Result<CodeOfConduct>

Get a code of conduct.

This function performs a GET to the /codes_of_conduct/{key} endpoint.

FROM: https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct

Parameters:

• key: &str

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

Get the code of conduct for a repository.

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

Returns the contents of the repository’s code of conduct file, if one is detected.

A code of conduct is detected if there is a file named CODE_OF_CONDUCT in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.

FROM: https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository

Parameters:

• owner: &str
• repo: &str