Struct rivet_matchmaker::client::fluent_builders::FindLobby

pub struct FindLobby<C, M, R = Standard> { /* private fields */ }

Fluent builder constructing a request to FindLobby.

Finds a lobby based on the given criteria. If a lobby is not found and prevent_auto_create_lobby is true, a new lobby will be created.

Implementations

impl<C, M, R> FindLobby<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<FindLobbyOutput, SdkError<FindLobbyError>> where
    R::Policy: SmithyRetryPolicy<FindLobbyInputOperationOutputAlias, FindLobbyOutput, FindLobbyError, FindLobbyInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn game_modes(self, input: impl Into<String>) -> Self

Appends an item to game_modes.

To override the contents of this collection use set_game_modes.

Game modes to match lobbies against.

pub fn set_game_modes(self, input: Option<Vec<String>>) -> Self

Game modes to match lobbies against.

pub fn regions(self, input: impl Into<String>) -> Self

Appends an item to regions.

To override the contents of this collection use set_regions.

Regions to match lobbies against. If not specified, the optimal region will be determined and will attempt to find lobbies in that region.

pub fn set_regions(self, input: Option<Vec<String>>) -> Self

Regions to match lobbies against. If not specified, the optimal region will be determined and will attempt to find lobbies in that region.

pub fn prevent_auto_create_lobby(self, input: bool) -> Self

Prevents a new lobby from being created when finding a lobby. If no lobby is found, a MATCHMAKER_LOBBY_NOT_FOUND error will be thrown.

pub fn set_prevent_auto_create_lobby(self, input: Option<bool>) -> Self

Prevents a new lobby from being created when finding a lobby. If no lobby is found, a MATCHMAKER_LOBBY_NOT_FOUND error will be thrown.

pub fn captcha(self, input: CaptchaConfig) -> Self

Methods to verify a captcha.

pub fn set_captcha(self, input: Option<CaptchaConfig>) -> Self

Methods to verify a captcha.

pub fn origin(self, input: impl Into<String>) -> Self

pub fn set_origin(self, input: Option<String>) -> Self

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for FindLobby<C, M, R>

fn clone(&self) -> FindLobby<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for FindLobby<C, M, R>

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

Formats the value using the given formatter.