Struct twitch_api::helix::channels::modify_channel_information::ModifyChannelInformationBody

#[non_exhaustive]
pub struct ModifyChannelInformationBody<'a> {
    pub game_id: Option<Cow<'a, CategoryIdRef>>,
    pub broadcaster_language: Option<Cow<'a, str>>,
    pub title: Option<Cow<'a, str>>,
}

Available on crate feature helix only.

Body Parameters for Modify Channel Information

modify-channel-information

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.

game_id: Option<Cow<'a, CategoryIdRef>>

Current game ID being played on the channel. Use “0” or “” (an empty string) to unset the game.

broadcaster_language: Option<Cow<'a, str>>

Language of the channel

title: Option<Cow<'a, str>>

Title of the stream. Value must not be an empty string.

Implementations

impl<'a> ModifyChannelInformationBody<'a>

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

Create a builder for building ModifyChannelInformationBody. On the builder, call .game_id(...)(optional), .broadcaster_language(...)(optional), .title(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ModifyChannelInformationBody.

impl<'a> ModifyChannelInformationBody<'a>

pub fn new() -> Self

Data to set on the stream.

Examples

let body = ModifyChannelInformationBody::new().game_id("123");

Examples found in repository

examples/modify_channel.rs (line 39)

↕

async fn run() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
    let _ = dotenvy::dotenv();
    let mut args = std::env::args().skip(1);
    let client: HelixClient<reqwest::Client> = HelixClient::new();
    let token = UserToken::from_existing(
        &client,
        std::env::var("TWITCH_TOKEN")
            .ok()
            .or_else(|| args.next())
            .map(AccessToken::new)
            .expect("Please set env: TWITCH_TOKEN or pass token as first argument"),
        None,
        None,
    )
    .await?;

    let broadcaster_id = token.validate_token(&client).await?.user_id.unwrap();

    let req = twitch_api::helix::channels::ModifyChannelInformationRequest::broadcaster_id(
        &broadcaster_id,
    );

    let mut body = twitch_api::helix::channels::ModifyChannelInformationBody::new();
    body.title("Hello World!");

    println!("scopes: {:?}", token.scopes());
    let response = client.req_patch(req, body, &token).await?;
    println!("{:?}", response);

    Ok(())
}

pub fn game_id(
    &mut self,
    game_id: impl IntoCow<'a, CategoryIdRef> + 'a
) -> &mut Self

Current game ID being played on the channel. Use “0” or “” (an empty string) to unset the game.

pub fn broadcaster_language(
    &mut self,
    broadcaster_language: impl Into<Cow<'a, str>>
) -> &mut Self

Language of the channel

pub fn title(&mut self, title: impl Into<Cow<'a, str>>) -> &mut Self

Title of the stream. Value must not be an empty string.

Examples found in repository

examples/modify_channel.rs (line 40)

↕

async fn run() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
    let _ = dotenvy::dotenv();
    let mut args = std::env::args().skip(1);
    let client: HelixClient<reqwest::Client> = HelixClient::new();
    let token = UserToken::from_existing(
        &client,
        std::env::var("TWITCH_TOKEN")
            .ok()
            .or_else(|| args.next())
            .map(AccessToken::new)
            .expect("Please set env: TWITCH_TOKEN or pass token as first argument"),
        None,
        None,
    )
    .await?;

    let broadcaster_id = token.validate_token(&client).await?.user_id.unwrap();

    let req = twitch_api::helix::channels::ModifyChannelInformationRequest::broadcaster_id(
        &broadcaster_id,
    );

    let mut body = twitch_api::helix::channels::ModifyChannelInformationBody::new();
    body.title("Hello World!");

    println!("scopes: {:?}", token.scopes());
    let response = client.req_patch(req, body, &token).await?;
    println!("{:?}", response);

    Ok(())
}

Trait Implementations

impl<'a> Clone for ModifyChannelInformationBody<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ModifyChannelInformationBody<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ModifyChannelInformationBody<'a>

fn default() -> ModifyChannelInformationBody<'a>

Returns the “default value” for a type.

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

fn eq(&self, other: &ModifyChannelInformationBody<'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<'a> Serialize for ModifyChannelInformationBody<'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 ModifyChannelInformationBody<'a>

impl<'a> StructuralEq for ModifyChannelInformationBody<'a>

impl<'a> StructuralPartialEq for ModifyChannelInformationBody<'a>