Struct PusherData

#[non_exhaustive]
pub struct PusherData {
    pub format: Option<PushFormat>,
    pub data: Map<String, Value>,
}

Available on crate feature api and (crate features push-gateway-api-c or push-gateway-api-s) only.

Information for the pusher implementation itself.

This is the data dictionary passed in at pusher creation minus the url key.

It can be constructed from ruma_common::push::HttpPusherData with ::from() / .into().

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.

format: Option<PushFormat>

The format to use when sending notifications to the Push Gateway.

data: Map<String, Value>

Custom data for the pusher.

Implementations

impl PusherData

pub fn new() -> PusherData

Creates an empty PusherData.

pub fn is_empty(&self) -> bool

Returns true if all fields are None or empty.

Trait Implementations

impl Clone for PusherData

fn clone(&self) -> PusherData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PusherData

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

Formats the value using the given formatter.

impl Default for PusherData

fn default() -> PusherData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PusherData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<HttpPusherData> for PusherData

fn from(data: HttpPusherData) -> PusherData

Converts to this type from the input type.

impl Serialize for PusherData

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.