Struct SearchResult

#[non_exhaustive]
pub struct SearchResult {
    pub context: EventContextResult,
    pub rank: Option<f64>,
    pub result: Option<Raw<AnyTimelineEvent>>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

A search result.

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.

context: EventContextResult

Context for result, if requested.

rank: Option<f64>

A number that describes how closely this result matches the search.

Higher is closer.

result: Option<Raw<AnyTimelineEvent>>

The event that matched.

Implementations

impl SearchResult

pub fn new() -> SearchResult

Creates an empty SearchResult.

pub fn is_empty(&self) -> bool

Returns true if all fields are empty / None.

Trait Implementations

impl Clone for SearchResult

fn clone(&self) -> SearchResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResult

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

Formats the value using the given formatter.

impl Default for SearchResult

fn default() -> SearchResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchResult

fn deserialize<__D>( __deserializer: __D, ) -> Result<SearchResult, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.