Skip to main content

UsersService

Struct UsersService 

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

Operations on users. Obtain via LinearClient::users.

Implementations§

Source§

impl<'a> UsersService<'a>

Source

pub async fn list(&self, req: ListUsersRequest) -> Result<Page<User>>

Fetches one page of users.

§Example
use linear_api::workspace::ListUsersRequest;

let client = linear_api::LinearClient::from_env()?;
let page = client
    .users()
    .list(ListUsersRequest::builder().first(50).build())
    .await?;
println!("has more: {}", page.page_info.has_next_page);
Source

pub fn list_stream( self, req: ListUsersRequest, ) -> impl Stream<Item = Result<User>> + 'a

Lazily streams every user matching the request across pages, starting from req.after when set (the cursor then advances page by page).

§Example
use futures::TryStreamExt;

let client = linear_api::LinearClient::from_env()?;
let users: Vec<_> = client
    .users()
    .list_stream(Default::default())
    .try_collect()
    .await?;
Source

pub async fn get(&self, id: &UserId) -> Result<User>

Fetches a single user by ID. For the authenticated user, use LinearClient::viewer instead.

§Example
let client = linear_api::LinearClient::from_env()?;
let user_id = linear_api::UserId::new("9c2c88a6-99d3-4a63-a201-8ee5c7dcc374");
let user = client.users().get(&user_id).await?;
println!("{}", user.display_name);

Trait Implementations§

Source§

impl<'a> Clone for UsersService<'a>

Source§

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

Source§

impl<'a> Debug for UsersService<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

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

§

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

§

impl<'a> Freeze for UsersService<'a>

§

impl<'a> Send for UsersService<'a>

§

impl<'a> Sync for UsersService<'a>

§

impl<'a> Unpin for UsersService<'a>

§

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