Struct QueryMessage

pub struct QueryMessage<I, A> {
    pub ltime: LamportTime,
    pub id: u32,
    pub from: Node<I, A>,
    pub filters: TinyVec<Bytes>,
    pub flags: QueryFlag,
    pub relay_factor: u8,
    pub timeout: Duration,
    pub name: SmolStr,
    pub payload: Bytes,
}

Query message

Fields

ltime: LamportTime

Event lamport time

id: u32

query id, randomly generated

from: Node<I, A>

source node

filters: TinyVec<Bytes>

Potential query filters

flags: QueryFlag

Used to provide various flags

relay_factor: u8

Used to set the number of duplicate relayed responses

timeout: Duration

Maximum time between delivery and response

name: SmolStr

Query nqme

payload: Bytes

Query payload

Implementations

impl<I, A> QueryMessage<I, A>

pub const fn ltime(&self) -> LamportTime

Returns the event lamport time

pub const fn id(&self) -> u32

Returns the query id

pub const fn from(&self) -> &Node<I, A>

Returns the from node

pub const fn filters(&self) -> &TinyVec<Bytes>

Returns the potential query filters

pub const fn flags(&self) -> QueryFlag

Returns the flags

pub const fn relay_factor(&self) -> u8

Returns the number of duplicate relayed responses

pub const fn timeout(&self) -> Duration

Returns the maximum time between delivery and response

pub const fn name(&self) -> &SmolStr

Returns the name of the query

pub const fn payload(&self) -> &Bytes

Returns the payload

pub const fn with_ltime(self, val: LamportTime) -> Self

Sets the event lamport time (Builder pattern)

pub fn with_id(self, val: u32) -> Self

Sets the query id (Builder pattern)

pub fn with_from(self, val: Node<I, A>) -> Self

Sets the from node (Builder pattern)

pub fn with_filters(self, val: TinyVec<Bytes>) -> Self

Sets the potential query filters (Builder pattern)

pub fn with_flags(self, val: QueryFlag) -> Self

Sets the flags (Builder pattern)

pub fn with_relay_factor(self, val: u8) -> Self

Sets the number of duplicate relayed responses (Builder pattern)

pub fn with_timeout(self, val: Duration) -> Self

Sets the maximum time between delivery and response (Builder pattern)

pub fn with_name(self, val: SmolStr) -> Self

Sets the name of the query (Builder pattern)

pub fn with_payload(self, val: Bytes) -> Self

Sets the payload (Builder pattern)

impl<I, A> QueryMessage<I, A>

pub fn ack(&self) -> bool

Checks if the ack flag is set

pub fn no_broadcast(&self) -> bool

Checks if the no broadcast flag is set

Trait Implementations

impl<I, A> AsMessageRef<I, A> for &QueryMessage<I, A>

fn as_message_ref(&self) -> SerfMessageRef<'_, I, A>

Converts this type into a shared reference of the (usually inferred) input type.

impl<I, A> AsMessageRef<I, A> for QueryMessage<I, A>

fn as_message_ref(&self) -> SerfMessageRef<'_, I, A>

Converts this type into a shared reference of the (usually inferred) input type.

impl<I: Clone, A: Clone> Clone for QueryMessage<I, A>

fn clone(&self) -> QueryMessage<I, A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug, A: Debug> Debug for QueryMessage<I, A>

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

Formats the value using the given formatter.

impl<'de, I, A> Deserialize<'de> for QueryMessage<I, A>

where I: Deserialize<'de>, A: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I: PartialEq, A: PartialEq> PartialEq for QueryMessage<I, A>

fn eq(&self, other: &QueryMessage<I, A>) -> 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<I, A> Serialize for QueryMessage<I, A>

where I: Serialize, A: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<I, A> Transformable for QueryMessage<I, A>

where I: Transformable, A: Transformable,

type Error = QueryMessageTransformError<I, A>

The error type returned when encoding or decoding fails.

fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error>

Encodes the value into the given buffer for transmission.

fn encoded_len(&self) -> usize

Returns the encoded length of the value. This is used to pre-allocate a buffer for encoding.

fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>

where Self: Sized,

Decodes the value from the given buffer received over the wire.

fn encode_to_vec(&self) -> Result<Vec<u8>, Self::Error>

Encodes the value into a vec for transmission.

fn encode_to_writer<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encodes the value into the given writer for transmission.

fn encode_to_async_writer<W>( &self, writer: &mut W, ) -> impl Future<Output = Result<usize, Error>> + Send

where W: AsyncWrite + Send + Unpin,

Encodes the value into the given async writer for transmission.

fn decode_from_reader<R>(reader: &mut R) -> Result<(usize, Self), Error>

where R: Read, Self: Sized,

Decodes the value from the given reader received over the wire.

fn decode_from_async_reader<R>( reader: &mut R, ) -> impl Future<Output = Result<(usize, Self), Error>> + Send

where R: AsyncRead + Send + Unpin, Self: Sized,

Decodes the value from the given async reader received over the wire.

impl<I: Eq, A: Eq> Eq for QueryMessage<I, A>

impl<I, A> StructuralPartialEq for QueryMessage<I, A>