Struct MessageQuery 

pub struct MessageQuery {
    pub offset: usize,
    pub limit: usize,
    pub after: Option<u64>,
    pub before: Option<u64>,
    pub order: MessageOrder,
    pub visibility: MessageVisibilityFilter,
    pub run_id: Option<String>,
}

Pagination/filter query for listing messages.

Fields

offset: usize

Number of items to skip.

limit: usize

Maximum number of items to return.

after: Option<u64>

Return records with sequence numbers greater than this value.

before: Option<u64>

Return records with sequence numbers less than this value.

order: MessageOrder

Sort order for message sequence numbers.

visibility: MessageVisibilityFilter

Visibility filter applied before pagination.

run_id: Option<String>

Filter by producing run ID.

Implementations

impl MessageQuery

pub fn normalized(&self) -> MessageQuery

Return a copy with contract-level pagination limits applied.

pub fn encode_cursor(&self, offset: usize) -> String

Encode an opaque cursor for continuing this exact query.

pub fn decode_cursor(&self, cursor: &str) -> Result<usize, String>

Decode a cursor and verify it belongs to this exact query shape.

pub fn matches_record(&self, record: &MessageRecord) -> bool

Return true when a record passes the query filters.

Trait Implementations

impl Clone for MessageQuery

fn clone(&self) -> MessageQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageQuery

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

Formats the value using the given formatter.

impl Default for MessageQuery

fn default() -> MessageQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageQuery

fn deserialize<__D>( __deserializer: __D, ) -> Result<MessageQuery, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MessageQuery

impl PartialEq for MessageQuery

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MessageQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MessageQuery