Struct ruma_common::directory::Filter

#[non_exhaustive]
pub struct Filter<'a> {
    pub generic_search_term: Option<&'a str>,
}

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<&'a str>

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

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<'a> Clone for Filter<'a>

fn clone(&self) -> Filter<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Filter<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Filter<'a>

fn default() -> Filter<'a>

Returns the “default value” for a type.

impl<'a> Outgoing for Filter<'a>

type Incoming = IncomingFilter

The ‘Incoming’ variant of Self.

impl<'a> Serialize for Filter<'a>

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

Serialize this value into the given Serde serializer.