Struct discord_sdk::lobby::search::SearchQuery

pub struct SearchQuery { /* fields omitted */ }

A query used to search for lobbies that match a set of criteria.

By default, this will find a maximum of 25 lobbies in the same or adjacent regions as the current user.

Implementations

impl SearchQuery

pub fn add_filter<'md>(
    self,
    key: impl Into<SearchKey<'md>>,
    comparison: LobbySearchComparison,
    value: SearchValue
) -> Self

Adds a filter to the query which compares the value of the specified key with the specified comparison against the specified value.

API docs

pub fn add_sort<'md>(
    self,
    key: impl Into<SearchKey<'md>>,
    value: SearchValue
) -> Self

Sorts the filtered lobbies based on “near-ness” of the specified key’s value to the specified sort value.

API docs

pub fn limit(self, max_results: Option<NonZeroU32>) -> Self

Sets the maximum number of lobbies that can be returned by the search.

API docs

pub fn distance(self, distance: LobbySearchDistance) -> Self

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

API docs

Trait Implementations

impl Default for SearchQuery

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for SearchQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.