Struct cloudevents::Event

pub struct Event { /* fields omitted */ }

Data structure that represents a CloudEvent. It provides methods to get the attributes through AttributesReader and write them through AttributesWriter. It also provides methods to read and write the event data.

You can build events using super::EventBuilder

use cloudevents::*;
use std::convert::TryInto;

// Create an event using the Default trait
let mut e = Event::default();
e.set_data(
    "application/json",
    serde_json::json!({"hello": "world"})
);

// Print the event id
println!("Event id: {}", e.id());

// Get the event data
let data: Option<Data> = e.data().cloned();
match data {
    Some(d) => println!("{}", d),
    None => println!("No event data")
}

Implementations

impl Event

pub fn iter(&self) -> impl Iterator<Item = (&str, AttributeValue<'_>)>

Returns an Iterator for all the available CloudEvents Context attributes and extensions. Same as chaining Event::iter_attributes() and Event::iter_extensions()

pub fn iter_attributes(
    &self
) -> impl Iterator<Item = (&str, AttributeValue<'_>)>

Returns an Iterator for all the available CloudEvents Context attributes, excluding extensions. This iterator does not contain the data field.

pub fn iter_extensions(&self) -> impl Iterator<Item = (&str, &ExtensionValue)>

Get all the extensions

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

Get data from this Event

pub fn take_data(&mut self) -> (Option<String>, Option<Url>, Option<Data>)

Take (datacontenttype, dataschema, data) from this event, leaving these fields empty

use cloudevents::Event;
use serde_json::json;
use std::convert::Into;

let mut e = Event::default();
e.set_data("application/json", json!({}));

let (datacontenttype, dataschema, data) = e.take_data();

pub fn set_data(
    &mut self,
    datacontenttype: impl Into<String>,
    data: impl Into<Data>
) -> (Option<String>, Option<Data>)

Set data into this Event with the specified datacontenttype. Returns the previous value of datacontenttype and data.

use cloudevents::Event;
use serde_json::json;
use std::convert::Into;

let mut e = Event::default();
let (old_datacontenttype, old_data) = e.set_data("application/json", json!({}));

pub fn set_data_unchecked(&mut self, data: impl Into<Data>) -> Option<Data>

Set data into this Event, without checking if there is a datacontenttype. Returns the previous value of data.

use cloudevents::Event;
use serde_json::json;
use std::convert::Into;

let mut e = Event::default();
let old_data = e.set_data_unchecked(json!({}));

pub fn extension(&self, extension_name: &str) -> Option<&ExtensionValue>

Get the extension named extension_name

pub fn set_extension<'name, 'event: 'name>(
    &'event mut self,
    extension_name: &'name str,
    extension_value: impl Into<ExtensionValue>
)

Set the extension named extension_name with extension_value

pub fn remove_extension<'name, 'event: 'name>(
    &'event mut self,
    extension_name: &'name str
) -> Option<ExtensionValue>

Remove the extension named extension_name

Trait Implementations

impl AttributesReader for Event

fn id(&self) -> &str

Get the id.

fn source(&self) -> &Url

Get the source.

fn specversion(&self) -> SpecVersion

Get the specversion.

fn ty(&self) -> &str

Get the type.

fn datacontenttype(&self) -> Option<&str>

Get the datacontenttype.

fn dataschema(&self) -> Option<&Url>

Get the dataschema.

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

Get the subject.

fn time(&self) -> Option<&DateTime<Utc>>

Get the time.

impl AttributesWriter for Event

fn set_id(&mut self, id: impl Into<String>) -> String

Set the id. Returns the previous value.

fn set_source(&mut self, source: impl Into<Url>) -> Url

Set the source. Returns the previous value.

fn set_type(&mut self, ty: impl Into<String>) -> String

Set the type. Returns the previous value.

fn set_subject(&mut self, subject: Option<impl Into<String>>) -> Option<String>

Set the subject. Returns the previous value.

fn set_time(
    &mut self,
    time: Option<impl Into<DateTime<Utc>>>
) -> Option<DateTime<Utc>>

Set the time. Returns the previous value.

fn set_datacontenttype(
    &mut self,
    datacontenttype: Option<impl Into<String>>
) -> Option<String>

Set the datacontenttype. Returns the previous value.

fn set_dataschema(&mut self, dataschema: Option<impl Into<Url>>) -> Option<Url>

Set the dataschema. Returns the previous value.

impl BinaryDeserializer for Event

fn deserialize_binary<R: Sized, V: BinarySerializer<R>>(
    self,
    visitor: V
) -> Result<R>

Deserialize the message to BinarySerializer.

fn into_event(self) -> Result<Event>

Convert this Message to Event.

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Event

fn deserialize<D>(
    deserializer: D
) -> Result<Self, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl From<Event> for EventBuilder

fn from(event: Event) -> Self

Performs the conversion.

impl From<Event> for EventBuilder

fn from(event: Event) -> Self

Performs the conversion.

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Event

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.

impl StructuralEq for Event

impl StructuralPartialEq for Event

impl StructuredDeserializer for Event

fn deserialize_structured<R, V: StructuredSerializer<R>>(
    self,
    visitor: V
) -> Result<R>

Deserialize the message to StructuredSerializer.

fn into_event(self) -> Result<Event>

Convert this Message to Event.