Struct ruma_common::directory::Filter

#[non_exhaustive]
pub struct Filter {
    pub generic_search_term: Option<String>,
    pub room_types: Vec<RoomTypeFilter>,
}

A filter for public rooms lists.

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.

generic_search_term: Option<String>

A string to search for in the room metadata, e.g. name, topic, canonical alias etc.

room_types: Vec<RoomTypeFilter>

The room types to include in the results.

Includes all room types if it is empty.

If the compat-null feature is enabled, a null value is allowed in deserialization, and treated the same way as an empty list.

Implementations

impl Filter

pub fn new() -> Self

Creates an empty Filter.

pub fn is_empty(&self) -> bool

Returns true if the filter is empty.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Filter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Filter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.