chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Provide a better explanation of stripped events.

Browse Source
This commit is contained in:
Jimmy Cuadra 2016-12-20 23:07:35 -08:00
parent 7a1a73c153
commit dc8bbbb5ac
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/stripped.rs
View File

@ -1,4 +1,9 @@
//! Stripped-down versions of certain state events. //! "Stripped-down" versions of the core state events.
//!
//! Each "stripped" event includes only the `content`, `type`, and `state_key` fields of its full
//! version. These stripped types are useful for APIs where the a is providing the content of a
//! state event to be created, when the other fields can be inferred from a larger context, or where
//! the other fields are otherwise inapplicable.
use serde::{Deserialize, Deserializer, Error as SerdeError, Serialize, Serializer}; use serde::{Deserialize, Deserializer, Error as SerdeError, Serialize, Serializer};
use serde_json::{Value, from_value}; use serde_json::{Value, from_value};
@ -57,7 +62,7 @@ pub enum StrippedState {
RoomTopic(StrippedRoomTopic), RoomTopic(StrippedRoomTopic),
} }
/// The general form of a `StrippedState`. /// A "stripped-down" version of a core state event.
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
pub struct StrippedStateContent<C> where C: Deserialize + Serialize { pub struct StrippedStateContent<C> where C: Deserialize + Serialize {
/// Data specific to the event type. /// Data specific to the event type.