Struct BanUserBody 

#[non_exhaustive]
pub struct BanUserBody {
    pub duration: Option<u32>,
    pub reason: String,
    pub user_id: UserId,
}

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: String

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: UserId

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

Implementations

impl BanUserBody

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

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

impl BanUserBody

pub fn new( user_id: impl Into<UserId>, reason: String, duration: impl Into<Option<u32>>, ) -> Self

Create a new BanUserBody

Trait Implementations

impl Clone for BanUserBody

fn clone(&self) -> BanUserBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BanUserBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BanUserBody

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 PartialEq for BanUserBody

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BanUserBody

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BanUserBody