Struct SearchConfig

pub struct SearchConfig { /* private fields */ }

Search configuration A search configuration allows users to limit the search to a specific room or limit the search to specific event types. The search result can be configured in various ways as well.

Implementations

impl SearchConfig

pub fn new() -> Self

Create a new default search configuration.

pub fn for_room(&mut self, room_id: &str) -> &mut Self

Limit the search to a specific room. The default is to search all rooms.

Arguments

• room_id - The unique id of the room.

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

Limit the number of events that will be returned in the search result. The default for the limit is 10.

Arguments

• limit - The max number of events to return in the search result.

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

Limit the number of events that happened before our matching event in the search result. The default for the limit is 0.

Arguments

• limit - The max number of contextual events to return in the search result.

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

Limit the number of events that happened after our matching event in the search result. The default for the limit is 0.

Arguments

• limit - The max number of contextual events to return in the search result.

pub fn order_by_recency(&mut self, order_by_recency: bool) -> &mut Self

Should the matching events be ordered by recency. The default is to order them by the search score.

Arguments

• order_by_recency - Flag to determine if we should order by recency. result.

pub fn with_key(&mut self, key: EventType) -> &mut Self

Set the event types that should be used as search keys.

This limits which events will be searched for. This method can be called multiple times to add multiple event types. The default is to search all event types.

Arguments

• key - The event type that should be included in the search.

pub fn next_batch(&mut self, token: Uuid) -> &mut Self

The point to return events from. If given, this should be a next_batch result from a previous search.

Trait Implementations

impl Clone for SearchConfig

fn clone(&self) -> SearchConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchConfig

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

Formats the value using the given formatter.

impl Default for SearchConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchConfig

where SearchConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchConfig

fn eq(&self, other: &SearchConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchConfig