Struct ReadOptions 

pub struct ReadOptions {
    pub timeout: Duration,
    pub quorum: Quorum,
    pub max_keys: usize,
    pub cursor: Option<Cursor>,
}

Options for operations that read from the DHT.

Fields

timeout: Duration

Maximum time to wait before abandoning the operation.

quorum: Quorum

How many replicas must answer before the result is returned.

max_keys: usize

Maximum number of DHT keys read to satisfy one lookup call.

A broad capability path may be spread across several keys, so a lookup can fan out. This bounds both the latency and the attacker-funded work of a single call; a truncated result reports a cursor.

cursor: Option<Cursor>

Where to resume a previous lookup, if any.

Implementations

impl ReadOptions

pub const DEFAULT_TIMEOUT: Duration

Default read timeout.

pub const DEFAULT_MAX_KEYS: usize = 16

Default maximum keys read per lookup.

pub const fn new() -> Self

Creates read options with the defaults.

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

Sets the timeout.

pub const fn with_quorum(self, quorum: Quorum) -> Self

Sets the quorum.

pub const fn with_max_keys(self, max_keys: usize) -> Self

Sets the maximum number of DHT keys read per lookup.

pub fn with_cursor(self, cursor: Cursor) -> Self

Resumes a lookup from a cursor returned by a previous page.

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadOptions

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

Formats the value using the given formatter.

impl Default for ReadOptions

fn default() -> Self

Quorum::One, matching the usual DHT read: the first replica to answer wins. Raise it when a stale or withheld record is a concern, since records are signed but a replica can still answer with an older one.

impl Eq for ReadOptions

impl PartialEq for ReadOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadOptions