Struct twitch_api::helix::moderation::BanUserBody

#[non_exhaustive]
pub struct BanUserBody<'a> {
    pub duration: Option<u32>,
    pub reason: Cow<'a, str>,
    pub user_id: Cow<'a, UserIdRef>,
}

Available on crate feature helix only.

Body Parameters for Ban User

ban-user

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

duration: Option<u32>

Duration of the (optional) timeout in seconds.

To ban a user indefinitely, don’t include this field.

To put a user in a timeout, include this field and specify the timeout period, in seconds. The minimum timeout is 1 second and the maximum is 1,209,600 seconds (2 weeks). To end a user’s timeout early, set this field to 1, or send an Unban user request.

reason: Cow<'a, str>

The reason the user is being banned or put in a timeout. The text is user defined and limited to a maximum of 500 characters.

user_id: Cow<'a, UserIdRef>

The ID of the user to ban or put in a timeout.

Implementations

impl<'a> BanUserBody<'a>

pub fn builder() -> BanUserBodyBuilder<'a, ((), (), ())>

Create a builder for building BanUserBody. On the builder, call .duration(...)(optional), .reason(...), .user_id(...) to set the values of the fields. Finally, call .build() to create the instance of BanUserBody.

impl<'a> BanUserBody<'a>

pub fn new(
    user_id: impl IntoCow<'a, UserIdRef> + 'a,
    reason: impl Into<Cow<'a, str>>,
    duration: impl Into<Option<u32>>
) -> Self

Create a new BanUserBody

Examples found in repository

src/helix/client/client_ext.rs (line 500)

↕

    pub async fn ban_user<'b, T>(
        &'a self,
        target_user_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        reason: impl Into<&'b str>,
        duration: impl Into<Option<u32>>,
        broadcaster_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        moderator_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        token: &T,
    ) -> Result<helix::moderation::BanUser, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        Ok(self
            .req_post(
                helix::moderation::BanUserRequest::new(broadcaster_id, moderator_id),
                helix::moderation::BanUserBody::new(target_user_id, reason.into(), duration),
                token,
            )
            .await?
            .data)
    }

Trait Implementations

impl<'a> Clone for BanUserBody<'a>

fn clone(&self) -> BanUserBody<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for BanUserBody<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for BanUserBody<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HelixRequestBody for BanUserBody<'_>

fn try_to_body(&self) -> Result<Bytes, BodyError>

Create the body

impl<'a> PartialEq<BanUserBody<'a>> for BanUserBody<'a>

fn eq(&self, other: &BanUserBody<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for BanUserBody<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for BanUserBody<'a>

impl<'a> StructuralEq for BanUserBody<'a>

impl<'a> StructuralPartialEq for BanUserBody<'a>