Struct NotificationRequest 

#[non_exhaustive]
pub struct NotificationRequest {
    pub event_type: String,
    pub identifier: BTreeMap<String, Value>,
    pub payload: Option<Value>,
}

A notification to publish via the server.

Marked #[non_exhaustive] so adding fields (for example, a future schema-version selector) is not a breaking change. Downstream code constructs requests via Self::new and the with_* builder methods rather than struct literals.

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.

event_type: String

Event type, matching a schema configured on the server (for example mars).

identifier: BTreeMap<String, Value>

Identifier key/value pairs, per the schema for event_type.

Values retain their JSON shape. Spatial identifiers use arrays, such as [46.0, 8.0] for a point or [[46.0, 8.0], [47.0, 9.0]] for a point cloud.

payload: Option<Value>

Optional free-form payload.

Implementations

impl NotificationRequest

pub fn new(event_type: impl Into<String>) -> Self

Builds a NotificationRequest with the required event_type and empty defaults for the other fields. Use Self::with_identifier and Self::with_payload to fill in.

pub fn with_identifier(self, identifier: BTreeMap<String, Value>) -> Self

Replaces the identifier map. Builder-style consumes and returns self.

Values retain their JSON shape, including scalars, arrays, and objects.

pub fn with_string_identifier( self, identifier: BTreeMap<String, String>, ) -> Self

Replaces the identifier map with string values converted to JSON strings.

Use Self::with_identifier when any value is not a string.

pub fn with_payload(self, payload: Value) -> Self

Sets the payload to Some(value). Builder-style consumes and returns self.

Trait Implementations

impl Clone for NotificationRequest

fn clone(&self) -> NotificationRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotificationRequest

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

Formats the value using the given formatter.

impl Serialize for NotificationRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.