Struct BaseEvent 

pub struct BaseEvent {
    pub timestamp: Option<i64>,
    pub raw_event: Option<Value>,
    pub metadata: Option<JsonObject>,
}

The fields every event may carry, flattened into the event’s own JSON object rather than nested under a key.

Fields

timestamp: Option<i64>

When the event was produced, in milliseconds since the Unix epoch.

raw_event: Option<Value>

The provider event this was translated from, for debugging.

metadata: Option<JsonObject>

Extra information, open by key. Absent or an object — a JSON null in place of the object is rejected. See crate::metadata for the reserved key and how consumers merge it into messages.

Implementations

impl BaseEvent

pub fn new() -> Self

An empty base — no timestamp, no raw event, no metadata.

pub const fn is_empty(&self) -> bool

Whether every field is absent, in which case the base contributes nothing to the serialized event.

Trait Implementations

impl Clone for BaseEvent

fn clone(&self) -> BaseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for BaseEvent

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for BaseEvent

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

Formats the value using the given formatter.

impl Default for BaseEvent

fn default() -> BaseEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BaseEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BaseEvent

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for BaseEvent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BaseEvent

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 BaseEvent

impl ToSchema for BaseEvent

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.