Struct UserListBuilder 

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

Builder for the users method.

Implementations

impl<C> UserListBuilder<C>

pub fn new(client: C) -> Self

Creates a builder with the client.

pub fn as_request(&self) -> &Request

Gets the request object for reuse.

pub fn order(&mut self, order: SortOrder<UserSortKey>) -> &mut Self

Sorts the results by the given order.

pub fn sort_by(&mut self, key: UserSortKey) -> &mut Self

Sorts the results in ascending order by the given key.

pub fn sort_by_followers(&mut self) -> &mut Self

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 Self

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 Self

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 Self

Limits the listed users by its origin.

pub fn local(&mut self) -> &mut Self

Limits the listed users to local ones.

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

pub fn remote(&mut self) -> &mut Self

Limits the listed users to remote ones.

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

pub fn moderator(&mut self) -> &mut Self

Limits the listed users to moderators.

pub fn alive(&mut self) -> &mut Self

Limits the listed users to alive ones.

pub fn admin(&mut self) -> &mut Self

Limits the listed users to admins.

pub fn admin_or_moderator(&mut self) -> &mut Self

Limits the listed users to admins or moderators.

impl<C: Client + Sync> UserListBuilder<C>

pub fn list(&self) -> PagerStream<BoxPager<'_, C, User>>

Lists the users.