Struct rivet_matchmaker::input::FindLobbyInput

#[non_exhaustive]
pub struct FindLobbyInput {
    pub game_modes: Option<Vec<String>>,
    pub regions: Option<Vec<String>>,
    pub prevent_auto_create_lobby: Option<bool>,
    pub captcha: Option<CaptchaConfig>,
    pub origin: Option<String>,
}

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_modes: Option<Vec<String>>

Game modes to match lobbies against.

regions: Option<Vec<String>>

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

prevent_auto_create_lobby: Option<bool>

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.

captcha: Option<CaptchaConfig>

Methods to verify a captcha.

origin: Option<String>

Implementations

impl FindLobbyInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<FindLobby, ()>, BuildError>

Consumes the builder and constructs an Operation<FindLobby>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture FindLobbyInput

impl FindLobbyInput

pub fn game_modes(&self) -> Option<&[String]>

Game modes to match lobbies against.

pub fn regions(&self) -> Option<&[String]>

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) -> Option<bool>

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) -> Option<&CaptchaConfig>

Methods to verify a captcha.

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

Trait Implementations

impl Clone for FindLobbyInput

fn clone(&self) -> FindLobbyInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FindLobbyInput

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

Formats the value using the given formatter.

impl PartialEq<FindLobbyInput> for FindLobbyInput

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