Struct cloudevents::event::Event

pub struct Event { /* private fields */ }

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) -> &UriReference

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<UriReference>) -> UriReference

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 From<Event> for EventBuilder

fn from(event: Event) -> Self

Converts to this type from the input type.

impl From<Event> for EventBuilder

fn from(event: Event) -> Self

Converts to this type from the input type.

impl<'a> FromRequest<'a> for Event

Available on crate feature poem only.

fn from_request<'life0, 'async_trait>( req: &'a Request, body: &'life0 mut RequestBody ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Extract from request head and body.

fn from_request_without_body<'async_trait>( req: &'a Request ) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send + 'async_trait, Global>>where 'a: 'async_trait, Self: Send + 'async_trait,

Extract from request head.

impl<B> FromRequest<B> for Eventwhere B: Body + Send, B::Data: Send, B::Error: Into<Box<dyn Error + Send + Sync>>,

Available on crate feature axum only.

type Rejection = (StatusCode, String)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>( req: &'life0 mut RequestParts<B> ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.

impl FromRequest for Event

Available on crate feature actix only.

So that an actix-web handler may take an Event parameter

type Error = Error

The associated error which can be returned.

type Future = Pin<Box<dyn Future<Output = Result<Event, <Event as FromRequest>::Error>> + 'static, Global>>

Future that resolves to a Self.

fn from_request(r: &HttpRequest, p: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

impl IntoResponse for Event

Available on crate feature poem only.

fn into_response(self) -> Response

Consume itself and return Response.

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>where K: TryInto<HeaderName>, V: TryInto<HeaderValue>, Self: Sized,

Wrap an impl IntoResponse to add a header.

fn with_status(self, status: StatusCode) -> WithStatus<Self>where Self: Sized,

Wrap an impl IntoResponse to set a status code.

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>where Self: Sized,

Wrap an impl IntoResponse to set a body.

impl IntoResponse for Event

Available on crate feature axum only.

fn into_response(self) -> Response<BoxBody>

Create a response.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Responder for Event

Available on crate feature actix only.

So that an actix-web handler may return an Event

type Body = BoxBody

fn respond_to(self, _: &HttpRequest) -> HttpResponse

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>where Self: Sized,

Wraps responder to allow alteration of its response.

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 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.

impl<T> TryFrom<Event> for Request<Option<T>>where T: TryFrom<Vec<u8>>, <T as TryFrom<Vec<u8>>>::Error: Debug,

Available on crate features http-binding or actix or warp or reqwest or axum or poem only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(event: Event) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<Response<T>> for Eventwhere T: TryInto<Vec<u8>>, <T as TryInto<Vec<u8>>>::Error: Debug,

Available on crate features http-binding or actix or warp or reqwest or axum or poem only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(response: Response<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Event

impl StructuralEq for Event

impl StructuralPartialEq for Event