Struct CloudEvent 

pub struct CloudEvent { /* private fields */ }

One CloudEvents 1.0 message.

Constructed by new for emission and by from_json / from_http for ingestion; both paths run the same checks, so an event this plane emits is one it would accept.

Implementations

impl CloudEvent

pub fn new( source: impl Into<String>, id: impl Into<String>, event_type: impl Into<String>, ) -> Result<Self, CloudEventError>

An event with the three attributes CloudEvents requires.

Errors

CloudEventError::MissingAttribute if any of them is empty. The spec says MUST be non-empty for all three, and an event missing one is one a conformant receiver refuses — better refused where it is written.

pub fn with_data(self, data: Value) -> Self

The JSON data, which becomes an InboundEvent’s payload.

pub fn with_subject(self, subject: impl Into<String>) -> Self

What this event is about within the producer — a run, an order, a meter. Distinct from source, which names the producer itself.

pub fn with_extension( self, name: impl Into<String>, value: Value, ) -> Result<Self, CloudEventError>

An extension attribute.

Errors

CloudEventError::BadExtensionName unless the name is lowercase letters and digits.

pub fn id(&self) -> &str

pub fn source(&self) -> &str

pub fn event_type(&self) -> &str

The type attribute. Spelled event_type because type is a keyword.

pub fn subject(&self) -> Option<&str>

pub const fn time(&self) -> Option<Timestamp>

The producer’s clock, if it set one. Never the runtime’s instant.

pub fn data(&self) -> Option<&Value>

pub fn extension(&self, name: &str) -> Option<&Value>

One extension attribute, if the producer set it.

pub fn origin_id(&self) -> String

The pair CloudEvents defines uniqueness by, as one string.

origin_key is the construction and says why it is shaped that way. The control-character refusal below is not what makes this unforgeable — the encoding is — it is CloudEvents holding its own attributes to what the specification allows.

pub fn into_inbound(self, transport_source: impl Into<String>) -> InboundEvent

This event as something a run can wait for.

source is not the event’s own: it is whoever the transport authenticated. A self-asserted source would make the deduplication identity a pair the sender controls both halves of, so one counterparty could deduplicate against another’s messages by naming them. The producer’s claim survives inside the id, as origin_id — which keeps a relay carrying many producers’ events from collapsing two of them into one.

pub fn from_json(body: &[u8]) -> Result<Self, CloudEventError>

Parse a structured-mode body.

Errors

CloudEventError when the body is not a JSON object, names another specversion, is missing a required attribute, or carries data this plane does not accept.

pub fn from_http<'a, I>( headers: I, body: &[u8], ) -> Result<Self, CloudEventError>

where I: IntoIterator<Item = (&'a str, &'a str)>,

Parse an HTTP message in whichever content mode it used.

Structured mode is chosen by the Content-Type; anything else is read as binary mode, where the attributes are ce--prefixed headers and the body is the data. headers is any iterator of (name, value); names are compared case-insensitively, as HTTP requires.

Errors

CloudEventError for the reasons from_json gives, plus a percent-encoded header value that is not UTF-8.

pub fn to_bytes(&self) -> Vec<u8>

The structured-mode body, with sorted keys.

Through the canonical writer for the reason canon gives: a body that is signed, or that a receiver verifies by re-serializing what it parsed, needs bytes that are a function of the event rather than of the order it was built in.

pub fn to_value(&self) -> Value

The structured-mode JSON, attributes flat beside data.

Trait Implementations

impl Clone for CloudEvent

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 CloudEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CloudEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CloudEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CloudEvent

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CloudEvent