Skip to main content

CommentsService

Struct CommentsService 

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

Comment operations, obtained via LinearClient::comments.

let client = linear_api::LinearClient::from_env()?;
let comment = client
    .comments()
    .create_on(linear_api::IssueRef::identifier("ENG-123"), "On it.")
    .await?;
println!("created {}", comment.url);

Implementations§

Source§

impl<'a> CommentsService<'a>

Source

pub async fn list_for_issue( &self, issue: impl Into<IssueRef>, req: CommentListRequest, ) -> Result<Page<Comment>>

Fetches one page of an issue’s comment thread (issue(id:) { comments }).

For the “latest N comments” pattern pass first: N on the request; ordering follows Linear’s default connection order (createdAt).

use linear_api::IssueRef;
use linear_api::comments::CommentListRequest;

let page = client
    .comments()
    .list_for_issue(
        IssueRef::identifier("ENG-123"),
        CommentListRequest::builder().first(5).build(),
    )
    .await?;
Source

pub fn list_for_issue_stream( &self, issue: impl Into<IssueRef>, req: CommentListRequest, ) -> impl Stream<Item = Result<Comment>> + 'a

Lazily streams an issue’s whole comment thread across pages via paginate.

req.first controls the page size; a pre-set req.after seeds the first page’s cursor.

use futures::TryStreamExt;
use linear_api::IssueRef;
use linear_api::comments::CommentListRequest;

let comments: Vec<_> = client
    .comments()
    .list_for_issue_stream(
        IssueRef::identifier("ENG-123"),
        CommentListRequest::builder().build(),
    )
    .try_collect()
    .await?;
Source

pub async fn create(&self, input: CommentCreateInput) -> Result<Comment>

Creates a comment (commentCreate). Thread replies via parent_id.

use linear_api::comments::CommentCreateInput;

let comment = client
    .comments()
    .create(
        CommentCreateInput::builder()
            .issue_id("ENG-123")
            .body("Run finished: all green.".to_owned())
            .build(),
    )
    .await?;
Source

pub async fn create_on( &self, issue: impl Into<IssueRef>, body: impl Into<String>, ) -> Result<Comment>

Convenience: creates a plain markdown comment on an issue.

use linear_api::IssueRef;

client
    .comments()
    .create_on(IssueRef::identifier("ENG-123"), "On it.")
    .await?;
Source

pub async fn update( &self, id: &CommentId, body: impl Into<String>, ) -> Result<Comment>

Replaces a comment’s markdown body (commentUpdate).

use linear_api::CommentId;

let id = CommentId::new("9d2a…");
client.comments().update(&id, "Edited: rollout done.").await?;
Source

pub async fn delete(&self, id: &CommentId) -> Result<()>

Deletes a comment (commentDelete).

use linear_api::CommentId;

let id = CommentId::new("9d2a…");
client.comments().delete(&id).await?;

Trait Implementations§

Source§

impl<'a> Clone for CommentsService<'a>

Source§

fn clone(&self) -> CommentsService<'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 CommentsService<'a>

Auto Trait Implementations§

§

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

§

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

§

impl<'a> Freeze for CommentsService<'a>

§

impl<'a> Send for CommentsService<'a>

§

impl<'a> Sync for CommentsService<'a>

§

impl<'a> Unpin for CommentsService<'a>

§

impl<'a> UnsafeUnpin for CommentsService<'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