Skip to main content

EventEnvelope

Struct EventEnvelope 

Source
pub struct EventEnvelope {
    pub event_id: EventId,
    pub stamp: FrameStamp,
    pub kind: EventKind,
    pub track_id: Option<TrackId>,
    pub subject_id: Option<SubjectId>,
    pub zone_id: Option<ZoneId>,
    pub evidence: Option<EvidenceRef>,
    pub payload: EventPayload,
}
Expand description

Versioned, queryable event record for a VisionIndex.

This is the shared contract between tracking, analytics, storage, and host products. It does not embed pixels or edit instructions.

Fields§

§event_id: EventId

Stable event id within an index document.

§stamp: FrameStamp

Temporal and source stamp for the event.

§kind: EventKind

Coarse kind for filtering.

§track_id: Option<TrackId>

Optional track association.

§subject_id: Option<SubjectId>

Optional long-lived subject association.

§zone_id: Option<ZoneId>

Optional zone association (also often present in payload).

§evidence: Option<EvidenceRef>

Optional evidence handle for reels / audit.

§payload: EventPayload

Kind-specific payload.

Implementations§

Source§

impl EventEnvelope

Source

pub fn new(event_id: EventId, stamp: FrameStamp, kind: EventKind) -> Self

Creates an envelope with empty payload and no optional associations.

Source

pub fn with_track(self, track_id: TrackId) -> Self

Builder-style track association.

Source

pub fn with_subject(self, subject_id: SubjectId) -> Self

Builder-style subject association.

Source

pub fn with_zone(self, zone_id: ZoneId) -> Self

Builder-style zone association.

Source

pub fn with_evidence(self, evidence: EvidenceRef) -> Self

Builder-style evidence handle.

Source

pub fn with_payload(self, payload: EventPayload) -> Self

Builder-style payload.

Trait Implementations§

Source§

impl Clone for EventEnvelope

Source§

fn clone(&self) -> EventEnvelope

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EventEnvelope

Source§

impl Debug for EventEnvelope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for EventEnvelope

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EventEnvelope

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.