Struct aws_sdk_gamelift::types::GameProperty

#[non_exhaustive]
pub struct GameProperty {
    pub key: Option<String>,
    pub value: Option<String>,
}

This key-value pair can store custom data about a game session. For example, you might use a GameProperty to track a game session's map, level of difficulty, or remaining time. The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"}.

You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.

For examples of working with game properties, see Create a game session with properties.

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.

key: Option<String>

The game property identifier.

value: Option<String>

The game property value.

Implementations

impl GameProperty

pub fn key(&self) -> Option<&str>

The game property identifier.

pub fn value(&self) -> Option<&str>

The game property value.

impl GameProperty

pub fn builder() -> GamePropertyBuilder

Creates a new builder-style object to manufacture GameProperty.

Trait Implementations

impl Clone for GameProperty

fn clone(&self) -> GameProperty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameProperty

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

Formats the value using the given formatter.

impl PartialEq for GameProperty

fn eq(&self, other: &GameProperty) -> 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 StructuralPartialEq for GameProperty