Struct twilight_http::request::guild::member::UpdateGuildMember

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

Update a guild member.

All fields are optional. See Discord Docs/Modify Guild Member.

Implementations

impl<'a> UpdateGuildMember<'a>

pub const fn channel_id(self, channel_id: Option<Id<ChannelMarker>>) -> Self

Move the member to a different voice channel.

pub fn communication_disabled_until( self, timestamp: Option<Timestamp> ) -> Result<Self, ValidationError>

Set the member’s Guild Timeout.

The timestamp indicates when the user will be able to communicate again. It can be up to 28 days in the future. Set to None to remove the timeout. Requires the MODERATE_MEMBERS permission. If this is set, and if the target member is an administrator or the owner of the guild, the response status code will be 403.

Errors

Returns an error of type CommunicationDisabledUntil if the expiry timestamp is more than 28 days from the current time.

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

If true, restrict the member’s ability to hear sound from a voice channel.

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

If true, restrict the member’s ability to speak in a voice channel.

pub fn nick(self, nick: Option<&'a str>) -> Result<Self, ValidationError>

Set the nickname.

The minimum length is 1 UTF-16 character and the maximum is 32 UTF-16 characters.

Errors

Returns an error of type Nickname if the nickname length is too short or too long.

pub const fn roles(self, roles: &'a [Id<RoleMarker>]) -> Self

Set the new list of roles for a member.

pub fn exec(self) -> ResponseFuture<Member>

👎Deprecated since 0.14.0: use .await or into_future instead

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

Trait Implementations

impl<'a> AuditLogReason<'a> for UpdateGuildMember<'a>

fn reason(self, reason: &'a str) -> Result<Self, ValidationError>

Attach an audit log reason to the request.

impl IntoFuture for UpdateGuildMember<'_>

type Output = Result<Response<Member>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<Member>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for UpdateGuildMember<'_>

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

Try to convert a request builder into a raw Request.