Struct SearchQuery

pub struct SearchQuery { /* private fields */ }

Lobby Search

Struct in official docs

Implementations

impl SearchQuery

pub fn new() -> Self

Creates a search object to search available lobbies.

Method in official docs

pub fn filter( &mut self, key: String, comparison: Comparison, value: String, cast: Cast, ) -> &mut Self

Filters lobbies based on metadata comparison.

Performance

A nul byte will be appended to key and value if one is not present.

Method in official docs

pub fn sort(&mut self, key: String, value: String, cast: Cast) -> &mut Self

Sorts the filtered lobbies based on “near-ness” to a given value

Performance

A nul byte will be appended to key and value if one is not present.

Method in official docs

pub fn limit(&mut self, limit: u32) -> &mut Self

Limits the number of lobbies returned in a search

Method in official docs

pub fn distance(&mut self, distance: Distance) -> &mut Self

Filters lobby results to within certain regions relative to the user’s location

Method in official docs

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchQuery

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

Formats the value using the given formatter.

impl Default for SearchQuery

fn default() -> SearchQuery

Returns the “default value” for a type.