Struct Emit Mark Event Params

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi.

pub struct EmitMarkEventParams<'a> {
    pub name: &'a str,
    pub parent: Option<&'a ScopeHandle>,
    pub data: Option<Json>,
    pub metadata: Option<Json>,
    pub timestamp: Option<DateTime<Utc>>,
}

Builder parameters for event.

Fields

name: &'a str

Event name to emit.

parent: Option<&'a ScopeHandle>

Optional explicit parent scope.

data: Option<Json>

Optional JSON payload recorded as the mark data.

metadata: Option<Json>

Optional JSON metadata recorded on the emitted event.

timestamp: Option<DateTime<Utc>>

Optional timestamp recorded on the emitted mark event. When omitted, the current UTC time is used.

Implementations

impl<'a> EmitMarkEventParams<'a>

impl<'a> EmitMarkEventParams<'a>

builder

pub fn builder() -> EmitMarkEventParamsBuilder<'a, ((), (), (), (), ())>

Create a builder for building EmitMarkEventParams. On the builder, call .name(...), .parent(...)(optional), .data(...)(optional), .metadata(...)(optional), .timestamp(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of EmitMarkEventParams.