Struct CustomStreamEvent 

pub struct CustomStreamEvent {
    pub base: BaseStreamEvent,
    pub name: String,
    pub data: Value,
}

Custom stream event created by the user.

Fields

base: BaseStreamEvent

The base event fields.

name: String

User defined name for the event.

data: Value

The data associated with the event. Free form and can be anything.

Implementations

impl CustomStreamEvent

pub fn new( run_id: impl Into<String>, name: impl Into<String>, data: Value, ) -> Self

Create a new CustomStreamEvent.

The event type is automatically set to “on_custom_event”.

pub fn with_tags(self, tags: Vec<String>) -> Self

Set the tags for this event.

pub fn with_metadata(self, metadata: HashMap<String, Value>) -> Self

Set the metadata for this event.

pub fn with_parent_ids(self, parent_ids: Vec<String>) -> Self

Set the parent IDs for this event.

Trait Implementations

impl Clone for CustomStreamEvent

fn clone(&self) -> CustomStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CustomStreamEvent> for StreamEvent

fn from(event: CustomStreamEvent) -> Self

Converts to this type from the input type.

impl Serialize for CustomStreamEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.