Struct twitch_api::helix::chat::GetUserChatColorRequest

#[non_exhaustive]
pub struct GetUserChatColorRequest<'a> {
    pub user_id: Cow<'a, [&'a UserIdRef]>,
}

Available on crate feature helix only.

Query Parameters for Get Chatters

get-user-chat-color

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.

user_id: Cow<'a, [&'a UserIdRef]>

The ID of the user whose color you want to get.

Implementations

impl<'a> GetUserChatColorRequest<'a>

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

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

impl<'a> GetUserChatColorRequest<'a>

pub fn user_ids(user_ids: impl Into<Cow<'a, [&'a UserIdRef]>>) -> Self

Get chat colors of specified users

Examples found in repository

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

≺ ≻↕

    pub async fn get_user_chat_color<T>(
        &'a self,
        user_id: impl Into<&types::UserIdRef>,
        token: &T,
    ) -> Result<Option<helix::chat::UserChatColor>, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        Ok(self
            .req_get(
                helix::chat::GetUserChatColorRequest::user_ids(&[user_id.into()][..]),
                token,
            )
            .await?
            .first())
    }

    /// Get a users chat color
    pub async fn update_user_chat_color<'b, T>(
        &'a self,
        user_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
        color: impl Into<types::NamedUserColor<'b>> + 'b,
        token: &T,
    ) -> Result<helix::chat::UpdateUserChatColorResponse, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        let req = helix::chat::UpdateUserChatColorRequest {
            user_id: user_id.to_cow(),
            color: color.into(),
        };

        Ok(self.req_put(req, helix::EmptyBody, token).await?.data)
    }

    /// Get multiple users chat colors
    pub async fn get_users_chat_colors<T>(
        &'a self,
        user_ids: impl AsRef<[&'a types::UserIdRef]>,
        token: &T,
    ) -> Result<Vec<helix::chat::UserChatColor>, ClientError<'a, C>>
    where
        T: TwitchToken + ?Sized,
    {
        let req = helix::chat::GetUserChatColorRequest::user_ids(user_ids.as_ref());

        Ok(self.req_get(req, token).await?.data)
    }

Trait Implementations

impl<'a> Clone for GetUserChatColorRequest<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GetUserChatColorRequest<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for GetUserChatColorRequest<'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<GetUserChatColorRequest<'a>> for GetUserChatColorRequest<'a>

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

type Response = Vec<UserChatColor, Global>

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

const PATH: &'static str = "chat/color"

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

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional 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 RequestGet for GetUserChatColorRequest<'_>

fn create_request(
    &self,
    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>, HelixRequestGetError>where
    Self: Sized,

Parse response.

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

Parse a response string into the response.

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

impl<'a> StructuralEq for GetUserChatColorRequest<'a>

impl<'a> StructuralPartialEq for GetUserChatColorRequest<'a>