Struct MilestonesClient 

pub struct MilestonesClient { /* private fields */ }

Domain client for milestone lifecycle operations.

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

Manages milestone definitions. To assign a milestone to a specific issue use IssuesClient::set_milestone; for a PR use PullRequestsClient::set_milestone.

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

Implementations

impl MilestonesClient

pub async fn list( &self, owner: &str, repo: &str, query: Option<ListMilestonesQuery>, ) -> Result<Vec<Milestone>, ApiError>

List all milestones in a repository (auto-paginated).

Errors

• ApiError::NotFound — repository does not exist

pub async fn get( &self, owner: &str, repo: &str, milestone_number: u64, ) -> Result<Milestone, ApiError>

Get a single milestone by its repository-scoped number.

Errors

• ApiError::NotFound — milestone does not exist

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

Create a new milestone.

Errors

• ApiError::InvalidRequest — title is empty
• ApiError::AuthorizationFailed — missing issues: write

pub async fn update( &self, owner: &str, repo: &str, milestone_number: u64, request: UpdateMilestoneRequest, ) -> Result<Milestone, ApiError>

Update an existing milestone.

Errors

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

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

Delete a milestone.

Issues assigned to the deleted milestone are unlinked but otherwise unaffected.

Errors

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

Trait Implementations

impl Clone for MilestonesClient

fn clone(&self) -> MilestonesClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MilestonesClient

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

Formats the value using the given formatter.