Struct holochain_p2p::actor::GetOptions

pub struct GetOptions {
    pub remote_agent_count: Option<u8>,
    pub timeout_ms: Option<u64>,
    pub as_race: bool,
    pub race_timeout_ms: Option<u64>,
    pub follow_redirects: bool,
    pub all_live_headers_with_metadata: bool,
    pub request_type: GetRequest,
}

Get options help control how the get is processed at various levels. Fields tagged with [Network] are network-level controls. Fields tagged with [Remote] are controls that will be forwarded to the remote agent processing this Get request.

Fields

remote_agent_count: Option<u8>

[Network] How many remote nodes should we make requests of / aggregate. Set to None for a default “best-effort”.

timeout_ms: Option<u64>

[Network] Timeout to await responses for aggregation. Set to None for a default “best-effort”. Note - if all requests time-out you will receive an empty result, not a timeout error.

as_race: bool

[Network] We are interested in speed. If true and we have any results when race_timeout_ms is expired, those results will be returned. After race_timeout_ms and before timeout_ms the first result received will be returned.

race_timeout_ms: Option<u64>

[Network] See as_race for details. Set to None for a default “best-effort” race.

follow_redirects: bool

[Remote] Whether the remote-end should follow redirects or just return the requested entry.

all_live_headers_with_metadata: bool

[Remote] Return all live headers even if there is deletes. Useful for metadata calls.

request_type: GetRequest

[Remote] The type of data this get request requires.

Trait Implementations

impl Clone for GetOptions

fn clone(&self) -> GetOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetOptions

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

Formats the value using the given formatter.

impl Default for GetOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ GetOptions> for GetOptions

fn from(a: &GetOptions) -> Self

Performs the conversion.

impl From<GetOptions> for GetOptions

fn from(_: GetOptions) -> Self

Performs the conversion.