Struct CalendarAlert 

#[non_exhaustive]
pub struct CalendarAlert {
    pub at_type: String,
    pub account_id: Id,
    pub calendar_event_id: Id,
    pub uid: String,
    pub recurrence_id: Option<String>,
    pub alert_id: String,
    pub extra: Map<String, Value>,
}

Push-notification payload emitted when a calendar alert fires (draft-ietf-jmap-calendars-33 §6.4).

Sent over the JMAP push channel when the server determines that an alert for a CalendarEvent should fire. Clients receiving this payload should trigger the appropriate local notification (e.g. an OS alert).

recurrenceId is null for non-recurring events and MUST serialize as null (not be omitted) — the receiver uses its presence to distinguish recurring from non-recurring.

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.

at_type: String

Object type discriminator; always "CalendarAlert" on the wire.

Deserialize is liberal: if @type is absent (spec-violating vendor input), this field defaults to "CalendarAlert" rather than failing the whole parent object’s deserialize. Serialize always emits the field. See bd:JMAP-ky8g.10.

account_id: Id

The account that owns the calendar event.

calendar_event_id: Id

Id of the CalendarEvent for which this alert is firing.

uid: String

The UID property of the iCalendar object underlying the calendar event.

recurrence_id: Option<String>

The recurrenceId of the specific occurrence, or null for non-recurring events (draft-ietf-jmap-calendars-33 §6.4).

Serializes as null when None — intentionally NOT marked skip_serializing_if so the receiver can distinguish recurring from non-recurring events.

Maintainer note: do NOT add #[serde(skip_serializing_if = "Option::is_none")] to this field. Adding it would silently break the spec contract: per draft-ietf-jmap-calendars-33 §6.4, the receiver uses the presence of recurrenceId to determine whether the alert fired for a recurring or non-recurring event. An omitted field is indistinguishable from a sender that forgot to include it; an explicit null carries the “non-recurring” signal. This is the same “required-and-nullable” wire shape used by PrincipalCalendarsCapability.account_id in capability.rs:121.

A “clippy clean-up”, “consistency PR”, or pattern-based code audit may flag this field as inconsistent with neighbours that use skip_serializing_if and propose to “fix” it. That is a silent wire-protocol break. The regression test calendar_alert_recurrence_id_null_for_non_recurring (in tests/types_test.rs) pins the current behavior. Design defense: bd:JMAP-1rwf.7.

alert_id: String

Id of the Alert object within the CalendarEvent that is firing.

extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Trait Implementations

impl Clone for CalendarAlert

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarAlert

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CalendarAlert

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CalendarAlert

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CalendarAlert

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CalendarAlert