Struct LabelsClient 

pub struct LabelsClient { /* private fields */ }

Domain client for repository-level label catalogue operations.

Obtained via InstallationClient::labels(). Cheap to clone (Arc-backed).

Manages label definitions. To apply labels to a specific issue use IssuesClient; to a PR use PullRequestsClient.

See docs/specs/interfaces/labels-client.md

Implementations

impl LabelsClient

pub async fn list( &self, owner: &str, repo: &str, ) -> Result<Vec<Label>, ApiError>

List all label definitions in a repository (auto-paginated).

Errors

• ApiError::NotFound — repository does not exist

pub async fn get( &self, owner: &str, repo: &str, name: &str, ) -> Result<Label, ApiError>

Get a single label definition by name.

Errors

• ApiError::NotFound — label does not exist

pub async fn create( &self, owner: &str, repo: &str, request: CreateLabelRequest, ) -> Result<Label, ApiError>

Create a new label definition.

Errors

• ApiError::InvalidRequest — name already exists (422)
• ApiError::AuthorizationFailed — missing issues: write

pub async fn update( &self, owner: &str, repo: &str, name: &str, request: UpdateLabelRequest, ) -> Result<Label, ApiError>

Update an existing label definition.

Renaming via new_name updates all existing issue/PR references.

Errors

• ApiError::NotFound — label does not exist
• ApiError::AuthorizationFailed — missing issues: write

pub async fn delete( &self, owner: &str, repo: &str, name: &str, ) -> Result<(), ApiError>

Delete a label definition.

Deleting a label removes it from all issues and PRs it was applied to.

Errors

• ApiError::NotFound — label does not exist
• ApiError::AuthorizationFailed — missing issues: write

Trait Implementations

impl Clone for LabelsClient

fn clone(&self) -> LabelsClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LabelsClient

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

Formats the value using the given formatter.