Struct ProjectHandler 

pub struct ProjectHandler<'octo> { /* private fields */ }

A struct to access GitHub’s projects API.

Created with Octocrab::projects.

Implementations

impl<'octo> ProjectHandler<'octo>

pub fn get_project( &self, project_id: impl Into<u32>, ) -> GetProjectBuilder<'_, '_>

Get a project by its id.

Arguments

• project_id - id of the project to fetch

let project_id: u32 = 1002604;
let project = octocrab::instance()
    .projects()
    .get_project(project_id)
    .send()
    .await?;

pub fn update_project<B>( &self, project_id: impl Into<u32>, ) -> UpdateProjectBuilder<'_, '_, B>

where B: Serialize + ?Sized,

Updates a project given its project id.

Arguments

• project_id - id of the project to update

let body = serde_json::json!({ "name": "Week One Sprint", "state": "open" });
let project_id: u32 = 1002604;
let project = octocrab::instance()
    .projects()
    .update_project(project_id)
    .body(&body)
    .send()
    .await?;

pub fn delete_project( &self, project_id: impl Into<u32>, ) -> DeleteProjectBuilder<'_, '_>

Deletes a project board.

Arguments

• project_id - id of the project to delete

let project_id: u32 = 1002604;
let project = octocrab::instance()
    .projects()
    .delete_project(project_id)
    .send()
    .await?;

pub fn create_user_project( &self, username: impl Into<String>, ) -> CreateUserProjectBuilder<'_, '_>

Creates a user project board given its name.

Arguments

• username - account username

let username = "octocat";
let description = "Project Overview";
let project = octocrab::instance()
    .projects()
    .create_user_project(username)
    .body(description)
    .send()
    .await?;

pub fn list_user_projects( &self, username: impl Into<String>, ) -> ListUserProjectsBuilder<'_, '_>

List a user’s projects the username of the user

Arguments

• username - account unsername

let username = "octocat";
let project = octocrab::instance()
    .projects()
    .list_user_projects(username)
    .send()
    .await?;

pub fn list_organization_projects( &self, org: impl Into<String>, ) -> ListOrgProjectsBuilder<'_, '_>

List the projects of an organization.

Notes

Only users with sufficient privileges can list an organization’s projects.

Arguments

• org - name of the organization

let org = "octocrab";
let projects = octocrab::instance()
    .projects()
    .list_organization_projects(org)
    .state("all")
    .send()
    .await?;

pub fn create_organization_project( &self, org: impl Into<String>, name: impl Into<String>, ) -> CreateOrgProjectsBuilder<'_, '_>

Create an organization project board.

Arguments

• org - organization name.
• name - name of the project.

let org = "octocrab";
let name = "Organization Roadmap";
let project = octocrab::instance()
    .projects()
    .create_organization_project(org, name)
    .send()
    .await?;

pub fn create_repository_project( &self, owner: impl Into<String>, repo: impl Into<String>, ) -> CreateRepositoryProjectsBuilder<'_, '_, NotNamed>

Creates a repository project board.

Arguments

• owner - repository owner.
• repo - repository name.

let owner = "octocat";
let repo = "octocrab";
let name = "My Project";
let description = "Project Overview";
let tags = octocrab::instance()
    .projects()
    .create_repository_project("owner", "repo")
    .project_name(name)
    .body(description)
    .send()
    .await?;

pub fn list_repository_projects( &self, owner: impl Into<String>, repo: impl Into<String>, ) -> ListRepositoryProjectsBuilder<'_, '_>

Lists the projects in a repository.

Arguments

• owner - repository owner.
• repo - repository name.

let owner = "octocat";
let repo = "octocrab";
let tags = octocrab::instance()
    .projects()
    .list_repository_projects("owner", "repo")
    .send()
    .await?;