Struct holochain::prelude::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_actions_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_actions_with_metadata: bool
[Remote]
Return all live actions 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() -> GetOptions
pub fn must_get_options() -> GetOptions
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
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for GetOptions
impl Debug for GetOptions
sourceimpl Default for GetOptions
impl Default for GetOptions
sourcefn default() -> GetOptions
fn default() -> GetOptions
sourceimpl From<&GetOptions> for GetOptions
impl From<&GetOptions> for GetOptions
sourcefn from(a: &GetOptions) -> GetOptions
fn from(a: &GetOptions) -> GetOptions
sourceimpl From<GetOptions> for GetOptions
impl From<GetOptions> for GetOptions
sourcefn from(_: GetOptions) -> GetOptions
fn from(_: GetOptions) -> GetOptions
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 Twhere
T: Any + ?Sized,
impl<T> Any for Twhere
T: Any + ?Sized,
fn type_id_compat(&self) -> TypeId
fn type_id_compat(&self) -> TypeId
impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
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> ⓘ
sourcefn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.