Struct QueryParam

pub struct QueryParam<I> { /* private fields */ }

Provided to Serf::query to configure the parameters of the query. If not provided, sane defaults will be used.

Implementations

impl<I> QueryParam<I>

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

Returns the filters of the query

pub const fn request_ack(&self) -> bool

Returns if we are requesting an delivery acknowledgement from every node that meets the filter requirement. This means nodes the receive the message but do not pass the filters, will not send an ack.

pub const fn relay_factor(&self) -> u8

Returns the number of duplicate responses to relay back to the sender through other nodes for redundancy.

pub const fn timeout(&self) -> Duration

Returns timeout limits how long the query is left open. If not provided, then a default timeout is used based on the configuration of Serf

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

Sets the filters of the query

pub fn with_request_ack(self, val: bool) -> Self

Sets if we are requesting an delivery acknowledgement from every node that meets the filter requirement. This means nodes the receive the message but do not pass the filters, will not send an ack.

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

Sets the number of duplicate responses to relay back to the sender through other nodes for redundancy.

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

Sets timeout limits how long the query is left open.

Trait Implementations

impl<I: Clone> Clone for QueryParam<I>

fn clone(&self) -> QueryParam<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for QueryParam<I>

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

Formats the value using the given formatter.

impl<'de, I> Deserialize<'de> for QueryParam<I>

where I: 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> Serialize for QueryParam<I>

where I: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.