Struct steamworks::LobbyListFilter
source · pub struct LobbyListFilter<'a> {
pub string: Option<StringFilters<'a>>,
pub number: Option<NumberFilters<'a>>,
pub near_value: Option<NearFilters<'a>>,
pub open_slots: Option<u8>,
pub distance: Option<DistanceFilter>,
pub count: Option<u64>,
}
Expand description
Filters for the lobbies to be returned from request_lobby_list
.
This struct is designed to be used as part of the filtering process
when calling the [set_lobby_list_filter
] method.
§Fields
string
: A string comparison filter that matches lobby attributes with specific strings.number
: A number comparison filter that matches lobby attributes with specific integer values.near_value
: Specifies a value, and the results will be sorted closest to this value (no actual filtering).open_slots
: Filters lobbies based on the number of open slots they have.distance
: Filters lobbies based on a distance criterion.count
: Specifies the maximum number of lobby results to be returned.
Fields§
§string: Option<StringFilters<'a>>
A string comparison filter that matches lobby attributes with specific strings.
number: Option<NumberFilters<'a>>
A number comparison filter that matches lobby attributes with specific integer values
near_value: Option<NearFilters<'a>>
Specifies a value, and the results will be sorted closest to this value (no actual filtering)
open_slots: Option<u8>
Filters lobbies based on the number of open slots they have
distance: Option<DistanceFilter>
Filters lobbies based on a distance criterion
count: Option<u64>
Specifies the maximum number of lobby results to be returned
Implementations§
source§impl<'a> LobbyListFilter<'a>
impl<'a> LobbyListFilter<'a>
sourcepub fn set_string(self, string: Option<StringFilters<'a>>) -> Self
pub fn set_string(self, string: Option<StringFilters<'a>>) -> Self
Sets the string comparison filter for the lobby list filter.
§Arguments
string
: A tuple containing the attribute name and the target string value to match.
sourcepub fn set_number(self, number: Option<NumberFilters<'a>>) -> Self
pub fn set_number(self, number: Option<NumberFilters<'a>>) -> Self
Sets the number comparison filter for the lobby list filter.
§Arguments
number
: A tuple containing the attribute name and the target integer value to match.
sourcepub fn set_near_value(self, near_value: Option<NearFilters<'a>>) -> Self
pub fn set_near_value(self, near_value: Option<NearFilters<'a>>) -> Self
Sets the near value filter for the lobby list filter.
§Arguments
near_value
: A tuple containing the attribute name and the reference integer value. Lobby results will be sorted based on their closeness to this value.
sourcepub fn set_open_slots(self, open_slots: Option<u8>) -> Self
pub fn set_open_slots(self, open_slots: Option<u8>) -> Self
Sets the open slots filter for the lobby list filter.
§Arguments
open_slots
: The number of open slots to filter lobbies by.
sourcepub fn set_distance(self, distance: Option<DistanceFilter>) -> Self
pub fn set_distance(self, distance: Option<DistanceFilter>) -> Self
Sets the distance filter for the lobby list filter.
§Arguments
distance
: A distance filter that specifies a distance criterion for filtering lobbies.
Trait Implementations§
source§impl<'a> Clone for LobbyListFilter<'a>
impl<'a> Clone for LobbyListFilter<'a>
source§fn clone(&self) -> LobbyListFilter<'a>
fn clone(&self) -> LobbyListFilter<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for LobbyListFilter<'a>
impl<'a> Debug for LobbyListFilter<'a>
source§impl<'a> Default for LobbyListFilter<'a>
impl<'a> Default for LobbyListFilter<'a>
source§fn default() -> LobbyListFilter<'a>
fn default() -> LobbyListFilter<'a>
source§impl<'a> PartialEq for LobbyListFilter<'a>
impl<'a> PartialEq for LobbyListFilter<'a>
source§fn eq(&self, other: &LobbyListFilter<'a>) -> bool
fn eq(&self, other: &LobbyListFilter<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.