Struct twitch_api::helix::users::BlockUserRequest

#[non_exhaustive]
pub struct BlockUserRequest<'a> {
    pub target_user_id: Cow<'a, UserIdRef>,
    pub source_context: Option<SourceContext>,
    pub reason: Option<Reason>,
}

Available on crate feature helix only.

Query Parameters for Block User

block-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.

target_user_id: Cow<'a, UserIdRef>

User ID of the follower

source_context: Option<SourceContext>

Source context for blocking the user. Valid values: “chat”, “whisper”.

reason: Option<Reason>

Reason for blocking the user. Valid values: “spam”, “harassment”, or “other”.

Implementations

impl<'a> BlockUserRequest<'a>

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

Create a builder for building BlockUserRequest. On the builder, call .target_user_id(...), .source_context(...)(optional), .reason(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of BlockUserRequest.

impl<'a> BlockUserRequest<'a>

pub fn block_user(target_user_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self

Block a user

Examples found in repository

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

↕

    pub async fn block_user<'b, T>(
        &'a self,
        target_user_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        token: &T,
    ) -> Result<helix::users::BlockUser, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        Ok(self
            .req_put(
                helix::users::BlockUserRequest::block_user(target_user_id),
                helix::EmptyBody,
                token,
            )
            .await?
            .data)
    }

pub fn source_context(self, source_context: impl Into<SourceContext>) -> Self

Set the source_context for this block.

pub fn reason(self, reason: impl Into<Reason>) -> Self

Set the reason for this block.

Trait Implementations

impl<'a> Clone for BlockUserRequest<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BlockUserRequest<'a>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<BlockUserRequest<'a>> for BlockUserRequest<'a>

fn eq(&self, other: &BlockUserRequest<'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 Request for BlockUserRequest<'_>

type Response = BlockUser

Response type. twitch’s response will deserialize to this.

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

const PATH: &'static str = "users/blocks"

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

fn query(&self) -> Result<String, SerializeError>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

impl RequestPut for BlockUserRequest<'_>

type Body = EmptyBody

Body parameters

fn parse_inner_response(
    request: Option<Self>,
    uri: &Uri,
    response: &str,
    status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestPutError>where
    Self: Sized,

Parse a response string into the response.

fn create_request(
    &self,
    body: Self::Body,
    token: &str,
    client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

fn parse_response<B: Into<Bytes>>(
    request: Option<Self>,
    uri: &Uri,
    response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestPutError>where
    Self: Sized,

Parse response.

impl<'a> Serialize for BlockUserRequest<'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 BlockUserRequest<'a>

impl<'a> StructuralEq for BlockUserRequest<'a>

impl<'a> StructuralPartialEq for BlockUserRequest<'a>