Skip to main content

ProjectsService

Struct ProjectsService 

Source
pub struct ProjectsService<'a> { /* private fields */ }
Expand description

Service for projects, project statuses, and project milestones. Obtain via LinearClient::projects.

Implementations§

Source§

impl<'a> ProjectsService<'a>

Source

pub async fn list(&self, request: ListProjectsRequest) -> Result<Page<Project>>

Fetches one page of projects.

use linear_api::projects::ListProjectsRequest;

let page = client
    .projects()
    .list(ListProjectsRequest::builder().first(50).build())
    .await?;
println!("{} projects, more: {}", page.nodes.len(), page.page_info.has_next_page);
Source

pub fn list_stream( &self, request: ListProjectsRequest, ) -> impl Stream<Item = Result<Project>> + 'a

Lazily streams every project matching request across pages, starting from request.after when set (the cursor then advances page by page). See crate::paginate for the complexity trade-offs.

use futures::TryStreamExt;
use linear_api::projects::ListProjectsRequest;

let projects: Vec<_> = client
    .projects()
    .list_stream(ListProjectsRequest::builder().first(50).build())
    .try_collect()
    .await?;
Source

pub async fn get(&self, id: &ProjectId) -> Result<Project>

Fetches a single project by ID. Linear also resolves slug IDs (the identifier from the project URL) passed as a ProjectId.

let id = linear_api::ProjectId::new("sdk-v1-8f2a1c0d3b4e");
let project = client.projects().get(&id).await?;
println!("{} — {:.0}% done", project.name, project.progress * 100.0);
Source

pub async fn create(&self, input: ProjectCreateInput) -> Result<Project>

Creates a project.

use linear_api::TeamId;
use linear_api::projects::ProjectCreateInput;

let project = client
    .projects()
    .create(
        ProjectCreateInput::builder()
            .name("SDK v1".to_owned())
            .team_ids(vec![TeamId::new("team-1")])
            .build(),
    )
    .await?;
Source

pub async fn update( &self, id: &ProjectId, input: ProjectUpdateInput, ) -> Result<Project>

Updates a project (Linear’s projectUpdate mutation, not the ProjectUpdate status-post entity). Undefinable fields on the input distinguish leave-unchanged from clear from set.

use linear_api::Undefinable;
use linear_api::projects::ProjectUpdateInput;

let id = linear_api::ProjectId::new("proj-1");
let project = client
    .projects()
    .update(
        &id,
        ProjectUpdateInput::builder()
            .target_date("2026-10-01".parse::<linear_api::TimelessDate>().unwrap())
            .lead_id(Undefinable::Null) // clear the lead
            .build(),
    )
    .await?;
Source

pub async fn archive(&self, id: &ProjectId) -> Result<()>

Archives a project.

let id = linear_api::ProjectId::new("proj-1");
client.projects().archive(&id).await?;
Source

pub async fn statuses(&self) -> Result<Vec<ProjectStatus>>

Fetches the workspace’s project statuses (a single page of up to 50 — workspaces define a handful).

for status in client.projects().statuses().await? {
    println!("{} ({:?})", status.name, status.status_type);
}
Source

pub async fn milestones(&self, id: &ProjectId) -> Result<Vec<ProjectMilestone>>

Fetches every milestone of a project, draining pagination internally (pages of 50, capped at 250 milestones).

let id = linear_api::ProjectId::new("proj-1");
for milestone in client.projects().milestones(&id).await? {
    println!("{} (order {})", milestone.name, milestone.sort_order);
}
Source

pub async fn create_milestone( &self, input: ProjectMilestoneCreateInput, ) -> Result<ProjectMilestone>

Creates a milestone within a project.

use linear_api::projects::ProjectMilestoneCreateInput;

let milestone = client
    .projects()
    .create_milestone(
        ProjectMilestoneCreateInput::builder()
            .project_id(linear_api::ProjectId::new("proj-1"))
            .name("M1 — Read path".to_owned())
            .build(),
    )
    .await?;
Source

pub async fn update_milestone( &self, id: &ProjectMilestoneId, input: ProjectMilestoneUpdateInput, ) -> Result<ProjectMilestone>

Updates a milestone.

use linear_api::Undefinable;
use linear_api::projects::ProjectMilestoneUpdateInput;

let id = linear_api::ProjectMilestoneId::new("ms-1");
let milestone = client
    .projects()
    .update_milestone(
        &id,
        ProjectMilestoneUpdateInput::builder()
            .name("M1 — Read path (done)".to_owned())
            .target_date(Undefinable::Null) // clear the target date
            .build(),
    )
    .await?;
Source

pub async fn delete_milestone(&self, id: &ProjectMilestoneId) -> Result<()>

Deletes a milestone.

let id = linear_api::ProjectMilestoneId::new("ms-1");
client.projects().delete_milestone(&id).await?;

Trait Implementations§

Source§

impl<'a> Clone for ProjectsService<'a>

Source§

fn clone(&self) -> ProjectsService<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for ProjectsService<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ProjectsService<'a>

§

impl<'a> !UnwindSafe for ProjectsService<'a>

§

impl<'a> Freeze for ProjectsService<'a>

§

impl<'a> Send for ProjectsService<'a>

§

impl<'a> Sync for ProjectsService<'a>

§

impl<'a> Unpin for ProjectsService<'a>

§

impl<'a> UnsafeUnpin for ProjectsService<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more