[][src]Struct misskey::builder::UserListBuilder

pub struct UserListBuilder<C> { /* fields omitted */ }

Builder for the users method.

Implementations

impl<C> UserListBuilder<C>[src]

pub fn new(client: C) -> UserListBuilder<C>[src]

Creates a builder with the client.

pub fn as_request(&self) -> &Request[src]

Gets the request object for reuse.

pub fn order(
    &mut self,
    order: SortOrder<UserSortKey>
) -> &mut UserListBuilder<C>
[src]

Sorts the results by the given order.

pub fn sort_by(&mut self, key: UserSortKey) -> &mut UserListBuilder<C>[src]

Sorts the results in ascending order by the given key.

pub fn sort_by_followers(&mut self) -> &mut UserListBuilder<C>[src]

Sorts the results in ascending order by number of followers.

This is equivalent to .sort_by(UserSortKey::Follower).

pub fn sort_by_creation_date(&mut self) -> &mut UserListBuilder<C>[src]

Sorts the results in ascending order by creation date.

This is equivalent to .sort_by(UserSortKey::CreatedAt).

pub fn sort_by_update_date(&mut self) -> &mut UserListBuilder<C>[src]

Sorts the results in ascending order by update date.

This is equivalent to .sort_by(UserSortKey::UpdatedAt).

pub fn origin(&mut self, origin: UserOrigin) -> &mut UserListBuilder<C>[src]

Limits the listed users by its origin.

pub fn local(&mut self) -> &mut UserListBuilder<C>[src]

Limits the listed users to local ones.

This is equivalent to .origin(UserOrigin::Local).

pub fn remote(&mut self) -> &mut UserListBuilder<C>[src]

Limits the listed users to remote ones.

This is equivalent to .origin(UserOrigin::Remote).

pub fn moderator(&mut self) -> &mut UserListBuilder<C>[src]

Limits the listed users to moderators.

pub fn alive(&mut self) -> &mut UserListBuilder<C>[src]

Limits the listed users to alive ones.

pub fn admin(&mut self) -> &mut UserListBuilder<C>[src]

Limits the listed users to admins.

pub fn admin_or_moderator(&mut self) -> &mut UserListBuilder<C>[src]

Limits the listed users to admins or moderators.

impl<C> UserListBuilder<C> where
    C: Sync + Client
[src]

pub fn list(
    &self
) -> PagerStream<Pin<Box<dyn Pager<Item = Result<Vec<User, Global>, Error<<C as Client>::Error>>, Content = User, Client = C> + Send, Global>>>
[src]

Lists the users.

Auto Trait Implementations

impl<C> RefUnwindSafe for UserListBuilder<C> where
    C: RefUnwindSafe
[src]

impl<C> Send for UserListBuilder<C> where
    C: Send
[src]

impl<C> Sync for UserListBuilder<C> where
    C: Sync
[src]

impl<C> Unpin for UserListBuilder<C> where
    C: Unpin
[src]

impl<C> UnwindSafe for UserListBuilder<C> where
    C: UnwindSafe
[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

impl<T> WithSubscriber for T[src]