Struct ruma_common::events::StateUnsigned

#[non_exhaustive]
pub struct StateUnsigned<C: StateEventContent> {
    pub age: Option<Int>,
    pub transaction_id: Option<OwnedTransactionId>,
    pub prev_content: Option<C>,
}

Extra information about a state event that is not incorporated into the event’s hash.

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.

age: Option<Int>

The time in milliseconds that has elapsed since the event was sent.

This field is generated by the local homeserver, and may be incorrect if the local time on at least one of the two servers is out of sync, which can cause the age to either be negative or greater than it actually is.

transaction_id: Option<OwnedTransactionId>

The client-supplied transaction ID, if the client being given the event is the same one which sent it.

prev_content: Option<C>

Optional previous content of the event.

Implementations

impl<C: StateEventContent> StateUnsigned<C>

pub fn new() -> Self

Create a new Unsigned with fields set to None.

pub fn is_empty(&self) -> bool

Whether this unsigned data is empty (all fields are None).

This method is used to determine whether to skip serializing the unsigned field in room events. Do not use it to determine whether an incoming unsigned field was present - it could still have been present but contained none of the known fields.

Trait Implementations

impl<C: Clone + StateEventContent> Clone for StateUnsigned<C>

fn clone(&self) -> StateUnsigned<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + StateEventContent> Debug for StateUnsigned<C>

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

Formats the value using the given formatter.

impl<C: StateEventContent> Default for StateUnsigned<C>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, C: StateEventContent> Deserialize<'de> for StateUnsigned<C> where
    C: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<C: StateEventContent> Serialize for StateUnsigned<C> where
    C: Serialize, 

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

Serialize this value into the given Serde serializer.