Struct twilight_http::request::scheduled_event::GetGuildScheduledEventUsers

pub struct GetGuildScheduledEventUsers<'a> { /* private fields */ }

Get a list of users subscribed to a scheduled event.

Users are returned in ascending order by user_id. before and after both take a user id. If both are specified, only before is respected. The default limit is 100. See Discord Docs/Get Guild Scheduled Event Users.

Implementations

impl<'a> GetGuildScheduledEventUsers<'a>

pub const fn after(self, after: Id<UserMarker>) -> Self

Get users after this user ID.

This is incompatible with before, and has no effect if before is also set.

pub const fn before(self, before: Id<UserMarker>) -> Self

Get users before this user ID.

This is incompatible with after.

pub const fn limit(self, limit: u16) -> Result<Self, ValidationError>

Set the limit of users to return.

If not specified, the default is 100.

Errors

Returns an error of type ScheduledEventGetUsers if the limit is invalid.

pub const fn with_member(self, with_member: bool) -> Self

Set whether to return member objects with each user.

pub fn exec(self) -> ResponseFuture<ListBody<GuildScheduledEventUser>>

👎Deprecated since 0.14.0: use .await or into_future instead

Execute the request, returning a future resolving to a Response.

Trait Implementations

impl IntoFuture for GetGuildScheduledEventUsers<'_>

type Output = Result<Response<ListBody<GuildScheduledEventUser>>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<ListBody<GuildScheduledEventUser>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for GetGuildScheduledEventUsers<'_>

fn try_into_request(self) -> Result<Request, Error>

Try to convert a request builder into a raw Request.