Skip to main content

OcsfEventBuilder

Struct OcsfEventBuilder 

Source
pub struct OcsfEventBuilder { /* private fields */ }
Expand description

Builder for OcsfEvent enforcing invariants at construction.

Implementations§

Source§

impl OcsfEventBuilder

Source

pub fn new( class: EventClass, session_uid: impl Into<String>, ai_agent: AgentIdentity, seq: u64, ) -> Self

Start building an event of class for session_uid with sequence seq.

Source

pub fn severity(self, id: u8) -> Self

Set severity (default 1 = informational).

Source

pub fn status(self, s: StatusId) -> Self

Set outcome status (default success).

Source

pub fn stop_reason(self, r: StopReason) -> Self

Attach a stop reason.

Source

pub fn stop_reason_native( self, reason: StopReason, native: impl Into<String>, ) -> Self

Attach a normalized reason and the provider’s source-native value.

Source

pub fn payload(self, p: Value) -> Self

Attach a class-specific payload.

Source

pub fn metrics(self, m: EventMetrics) -> Self

Attach token metrics.

Source

pub fn inventory( self, current: Fingerprint, previous: Option<Fingerprint>, ) -> Self

Attach inventory fingerprints (roadmap feature).

Source

pub fn build(self) -> Result<OcsfEvent, CoreError>

Build, validating JCS-safety of all counters.

Trait Implementations§

Source§

impl Debug for OcsfEventBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more