Struct twitch_api::helix::users::block_user::BlockUserRequest
source · [−]#[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.Expand description
Query Parameters for Block User
Fields (Non-exhaustive)
This struct is marked as 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
sourceimpl<'a> BlockUserRequest<'a>
impl<'a> BlockUserRequest<'a>
sourcepub fn builder() -> BlockUserRequestBuilder<'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
.
sourceimpl<'a> BlockUserRequest<'a>
impl<'a> BlockUserRequest<'a>
sourcepub fn block_user(target_user_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
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)
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
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)
}
sourcepub fn source_context(self, source_context: impl Into<SourceContext>) -> Self
pub fn source_context(self, source_context: impl Into<SourceContext>) -> Self
Set the source_context for this block.
Trait Implementations
sourceimpl<'a> Clone for BlockUserRequest<'a>
impl<'a> Clone for BlockUserRequest<'a>
sourcefn clone(&self) -> BlockUserRequest<'a>
fn clone(&self) -> BlockUserRequest<'a>
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 moresourceimpl<'a> Debug for BlockUserRequest<'a>
impl<'a> Debug for BlockUserRequest<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for BlockUserRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for BlockUserRequest<'a>
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<'a> PartialEq<BlockUserRequest<'a>> for BlockUserRequest<'a>
impl<'a> PartialEq<BlockUserRequest<'a>> for BlockUserRequest<'a>
sourcefn eq(&self, other: &BlockUserRequest<'a>) -> bool
fn eq(&self, other: &BlockUserRequest<'a>) -> bool
sourceimpl Request for BlockUserRequest<'_>
impl Request for BlockUserRequest<'_>
sourceconst OPT_SCOPE: &'static [Scope] = _
const OPT_SCOPE: &'static [Scope] = _
Available on crate feature
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 Informationsourceconst SCOPE: &'static [Scope] = _
const SCOPE: &'static [Scope] = _
Available on crate feature
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 clientsourceimpl<'a> Serialize for BlockUserRequest<'a>
impl<'a> Serialize for BlockUserRequest<'a>
impl<'a> Eq for BlockUserRequest<'a>
impl<'a> StructuralEq for BlockUserRequest<'a>
impl<'a> StructuralPartialEq for BlockUserRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for BlockUserRequest<'a>
impl<'a> Send for BlockUserRequest<'a>
impl<'a> Sync for BlockUserRequest<'a>
impl<'a> Unpin for BlockUserRequest<'a>
impl<'a> UnwindSafe for BlockUserRequest<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.