Struct serenity::model::gateway::Game

pub struct Game {
    pub kind: GameType,
    pub name: String,
    pub url: Option<String>,
}

Representation of a game that a [User] is playing -- or streaming in the case that a stream URL is provided.

Fields

kind: GameType

The type of game status.

name: String

The name of the game being played.

url: Option<String>

The Stream URL if kind is GameType::Streaming.

Methods

impl Game

pub fn playing(name: &str) -> Game

Creates a Game struct that appears as a Playing <name> status.

Note: Maximum name length is 128.

Examples

Create a command that sets the current game being played:

use serenity::framework::standard::Args;
use serenity::model::gateway::Game;

command!(game(ctx, _msg, args) {
    let name = args.full();
    ctx.set_game(Game::playing(&name));
});

pub fn streaming(name: &str, url: &str) -> Game

Creates a Game struct that appears as a Streaming <name> status.

Note: Maximum name length is 128.

Examples

Create a command that sets the current game and stream:

use serenity::framework::standard::Args;
use serenity::model::gateway::Game;

// Assumes command has min_args set to 2.
command!(stream(ctx, _msg, args) {
    let name = args.full();
    ctx.set_game(Game::streaming(&name, &stream_url));
});

pub fn listening(name: &str) -> Game

Creates a Game struct that appears as a Listening to <name> status.

Note: Maximum name length is 128.

Examples

Create a command that sets the current game being played:

use serenity::framework::standard::Args;
use serenity::model::gateway::Game;

command!(listen(ctx, _msg, args) {
    let name = args.full();
    ctx.set_game(Game::listening(&name));
});

Trait Implementations

impl Clone for Game

fn clone(&self) -> Game

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Game

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Game

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> StdResult<Self, D::Error>

Deserialize this value from the given Serde deserializer.