Struct dendrite_auth::dendrite::axon_server::event::QueryEventsRequest

pub struct QueryEventsRequest {
    pub query: String,
    pub number_of_permits: i64,
    pub live_events: bool,
    pub force_read_from_leader: bool,
}

Message providing the parameters for executing a Query against AxonServer.

Fields

query: String

The query to execute against the Event Stream

number_of_permits: i64

The number of results AxonServer may send before new permits need to be provided

live_events: bool

Whether to keep the query running against incoming events once the Head of the Stream is reached

force_read_from_leader: bool

Indicates whether to force querying events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability.

This property has no effect on connections to AxonServer SE.

Trait Implementations

impl Clone for QueryEventsRequest

fn clone(&self) -> QueryEventsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryEventsRequest

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

Formats the value using the given formatter.

impl Default for QueryEventsRequest

fn default() -> QueryEventsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryEventsRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for QueryEventsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for QueryEventsRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for QueryEventsRequest

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 QueryEventsRequest