Enum ruma::api::client::threads::get_threads::v1::IncludeThreads

#[non_exhaustive]
pub enum IncludeThreads {
    All,
    Participated,
}

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

Which threads to include in the response.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

All

all

Include all thread roots found in the room.

This is the default.

Participated

participated

Only include thread roots for threads where current_user_participated is true.

Implementations

impl IncludeThreads

pub fn as_str(&self) -> &str

Creates a string slice from this IncludeThreads.

Trait Implementations

impl AsRef<str> for IncludeThreads

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IncludeThreads

fn clone(&self) -> IncludeThreads

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeThreads

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

Formats the value using the given formatter.

impl Default for IncludeThreads

fn default() -> IncludeThreads

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncludeThreads

fn deserialize<D>( deserializer: D, ) -> Result<IncludeThreads, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IncludeThreads

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

Formats the value using the given formatter.

impl<T> From<T> for IncludeThreads

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> IncludeThreads

Converts to this type from the input type.

impl Ord for IncludeThreads

fn cmp(&self, other: &IncludeThreads) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for IncludeThreads

fn eq(&self, other: &IncludeThreads) -> 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 PartialOrd for IncludeThreads

fn partial_cmp(&self, other: &IncludeThreads) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IncludeThreads

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.

impl Eq for IncludeThreads

impl StructuralPartialEq for IncludeThreads