Skip to main content

EventQuery

Struct EventQuery 

Source
pub struct EventQuery {
    pub topic: Option<String>,
    pub project_id: Option<String>,
    pub scope_id: Option<String>,
    pub from_commit_seq_exclusive: Option<u64>,
    pub to_commit_seq_exclusive: Option<u64>,
    pub from_ts_micros: Option<u64>,
    pub to_ts_micros: Option<u64>,
    pub field_filters: Vec<EventFieldFilter>,
    pub order: EventOrder,
    pub limit: usize,
}
Expand description

Ergonomic query over the canonical event log (the event_outbox system table). Supports filtering by event type (topic), project/scope, commit-sequence range (cursor pagination), time range, and arbitrary payload fields (recipient, instance_id, block, …), in either direction.

Construct with EventQuery::new and the builder methods, then pass to AedbInstance::query_events. Pagination is commit-atomic: a page never splits the events emitted by a single commit, and the returned EventStreamPage::next_commit_seq is the cursor for the next page (feed it back as from_commit_seq_exclusive for ascending queries, or to_commit_seq_exclusive for descending queries).

Fields§

§topic: Option<String>

Event type filter (matches the emit topic). None matches all.

§project_id: Option<String>

Restrict to events emitted under this project. None matches all.

§scope_id: Option<String>

Restrict to events emitted under this scope. None matches all.

§from_commit_seq_exclusive: Option<u64>

Exclusive lower bound on commit sequence (ascending cursor).

§to_commit_seq_exclusive: Option<u64>

Exclusive upper bound on commit sequence (descending cursor).

§from_ts_micros: Option<u64>

Inclusive lower bound on event timestamp (micros since epoch).

§to_ts_micros: Option<u64>

Inclusive upper bound on event timestamp (micros since epoch).

§field_filters: Vec<EventFieldFilter>

Payload field equality filters (ANDed together).

§order: EventOrder

Scan direction.

§limit: usize

Maximum number of events to return in this page.

Implementations§

Source§

impl EventQuery

Source

pub fn new() -> Self

Start an empty query (ascending, no filters). Set limit before use; a limit of 0 yields an empty page.

Source

pub fn topic(self, topic: impl Into<String>) -> Self

Filter by event type (the emit topic).

Source

pub fn namespace( self, project_id: impl Into<String>, scope_id: impl Into<String>, ) -> Self

Restrict to a single project / scope namespace.

Source

pub fn after_commit_seq(self, seq: u64) -> Self

Resume an ascending scan after this commit sequence (exclusive).

Source

pub fn before_commit_seq(self, seq: u64) -> Self

Resume a descending scan before this commit sequence (exclusive).

Source

pub fn time_range( self, from_micros: Option<u64>, to_micros: Option<u64>, ) -> Self

Inclusive timestamp window (micros since epoch).

Source

pub fn where_field( self, field: impl Into<String>, equals: impl Into<String>, ) -> Self

Add a payload-field equality filter (e.g. recipient, instance_id, block).

Source

pub fn descending(self) -> Self

Newest-first ordering (for “latest N by type”).

Source

pub fn limit(self, limit: usize) -> Self

Page size.

Trait Implementations§

Source§

impl Clone for EventQuery

Source§

fn clone(&self) -> EventQuery

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 Debug for EventQuery

Source§

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

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

impl Default for EventQuery

Source§

fn default() -> EventQuery

Returns the “default value” for a type. Read more
Source§

impl Eq for EventQuery

Source§

impl PartialEq for EventQuery

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for EventQuery

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> Instrument for T

Source§

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

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

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> 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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