Struct twitch_api2::helix::users::BlockUserRequest
source · [−]#[non_exhaustive]pub struct BlockUserRequest {
pub target_user_id: UserId,
pub source_context: Option<SourceContext>,
pub reason: Option<Reason>,
}
helix
only.Expand description
Query Parameters for Block User
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.target_user_id: UserId
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
sourceimpl BlockUserRequest
impl BlockUserRequest
sourcepub fn builder() -> BlockUserRequestBuilder<((), (), ())>
pub fn builder() -> BlockUserRequestBuilder<((), (), ())>
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
.
Trait Implementations
sourceimpl Clone for BlockUserRequest
impl Clone for BlockUserRequest
sourcefn clone(&self) -> BlockUserRequest
fn clone(&self) -> BlockUserRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BlockUserRequest
impl Debug for BlockUserRequest
sourceimpl<'de> Deserialize<'de> for BlockUserRequest
impl<'de> Deserialize<'de> for BlockUserRequest
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<BlockUserRequest> for BlockUserRequest
impl PartialEq<BlockUserRequest> for BlockUserRequest
sourcefn eq(&self, other: &BlockUserRequest) -> bool
fn eq(&self, other: &BlockUserRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BlockUserRequest) -> bool
fn ne(&self, other: &BlockUserRequest) -> bool
This method tests for !=
.
sourceimpl Request for BlockUserRequest
impl Request for BlockUserRequest
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Optional scopes needed by this endpoint
sourceconst PATH: &'static str = "users/blocks"
const PATH: &'static str = "users/blocks"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::UserManageBlockedUsers]
const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::UserManageBlockedUsers]
twitch_oauth2
only.Scopes needed by this endpoint
sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
Defines layout of the url parameters.
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
Returns full URI for the request, including query parameters.
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
sourceimpl RequestPut for BlockUserRequest
impl RequestPut for BlockUserRequest
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestPutError> where
Self: Sized,
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.
sourcefn create_request(
&self,
body: Self::Body,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
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
sourceimpl Serialize for BlockUserRequest
impl Serialize for BlockUserRequest
impl StructuralPartialEq for BlockUserRequest
Auto Trait Implementations
impl RefUnwindSafe for BlockUserRequest
impl Send for BlockUserRequest
impl Sync for BlockUserRequest
impl Unpin for BlockUserRequest
impl UnwindSafe for BlockUserRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more