Enum ruma_events::receipt::ReceiptThread

#[non_exhaustive]
pub enum ReceiptThread {
    Unthreaded,
    Main,
    Thread(OwnedEventId),
}

The thread a receipt applies to.

This type can hold an arbitrary string. To build this with a custom value, convert it from an Option<String> with ::from() / .into(). ReceiptThread::Unthreaded can be constructed from None.

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.

Unthreaded

The receipt applies to the timeline, regardless of threads.

Used by clients that are not aware of threads.

This is the default.

Main

The receipt applies to the main timeline.

Used for events that don’t belong to a thread.

Thread(OwnedEventId)

The receipt applies to a thread.

Used for events that belong to a thread with the given thread root.

Implementations

impl ReceiptThread

pub fn as_str(&self) -> Option<&str>

Get the string representation of this ReceiptThread.

ReceiptThread::Unthreaded returns None.

Trait Implementations

impl Clone for ReceiptThread

fn clone(&self) -> ReceiptThread

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptThread

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

Formats the value using the given formatter.

impl Default for ReceiptThread

fn default() -> ReceiptThread

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReceiptThread

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ReceiptThread

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReceiptThread

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ReceiptThread

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryFrom<Option<T>> for ReceiptThread

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Option<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ReceiptThread

impl StructuralPartialEq for ReceiptThread