Struct holochain_p2p::actor::GetOptions
source · [−]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,
}
Expand description
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.
Implementations
sourceimpl GetOptions
impl GetOptions
sourcepub fn must_get_options() -> Self
pub fn must_get_options() -> Self
Using defaults is dangerous in a must_get as it can undermine determinism. We want refactors to explicitly consider this.
Trait Implementations
sourceimpl Clone for GetOptions
impl Clone for GetOptions
sourcefn clone(&self) -> GetOptions
fn clone(&self) -> GetOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetOptions
impl Debug for GetOptions
sourceimpl Default for GetOptions
impl Default for GetOptions
sourceimpl From<&'_ GetOptions> for GetOptions
impl From<&'_ GetOptions> for GetOptions
sourcefn from(a: &GetOptions) -> Self
fn from(a: &GetOptions) -> Self
Converts to this type from the input type.
sourceimpl From<GetOptions> for GetOptions
impl From<GetOptions> for GetOptions
sourcefn from(_: GetOptions) -> Self
fn from(_: GetOptions) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl RefUnwindSafe for GetOptions
impl Send for GetOptions
impl Sync for GetOptions
impl Unpin for GetOptions
impl UnwindSafe for GetOptions
Blanket Implementations
impl<T> Any for T where
T: Any + ?Sized,
impl<T> Any for T where
T: Any + ?Sized,
fn type_id_compat(&self) -> TypeId
fn type_id_compat(&self) -> TypeId
TODO: once 1.33.0 is the minimum supported compiler version, remove Any::type_id_compat and use StdAny::type_id instead. https://github.com/rust-lang/rust/issues/27745 Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> FutureExt for T
impl<T> FutureExt for T
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more