Struct holochain::prelude::ChainFilter
pub struct ChainFilter<H = HoloHash<Action>>where
H: Eq + Ord + Hash,{
pub chain_top: H,
pub filters: ChainFilters<H>,
pub include_cached_entries: bool,
}
Expand description
Filter source chain items.
Starting from some chain position given as an ActionHash
the chain is walked backwards to genesis.
The filter can stop early by specifying the number of
chain items to take and / or an ActionHash
to consume until.
Fields§
§chain_top: H
The starting position of the filter.
filters: ChainFilters<H>
The filters that have been applied.
Defaults to ChainFilters::ToGenesis
.
include_cached_entries: bool
Should the query return any entries that are cached at the agent activity to save network hops.
Implementations§
§impl<H> ChainFilter<H>where
H: Eq + Ord + Hash,
impl<H> ChainFilter<H>where H: Eq + Ord + Hash,
pub fn new(chain_top: H) -> ChainFilter<H>
pub fn new(chain_top: H) -> ChainFilter<H>
Create a new filter using this ActionHash
as
the starting position and walking the chain
towards the genesis Action
.
pub fn take(self, n: u32) -> ChainFilter<H>
pub fn take(self, n: u32) -> ChainFilter<H>
Take up to n
actions including the starting position.
This may return less then n
actions.
pub fn include_cached_entries(self) -> ChainFilter<H>
pub fn include_cached_entries(self) -> ChainFilter<H>
Set this filter to include any cached entries at the agent activity authority.
pub fn until(self, action_hash: H) -> ChainFilter<H>
pub fn until(self, action_hash: H) -> ChainFilter<H>
Take all actions until this action hash is found.
Note that all actions specified as until
hashes must be
found so this filter can produce deterministic results.
It is invalid to specify an until hash that is on a different
fork then the starting position.
pub fn get_until(&self) -> Option<&HashSet<H, RandomState>>
pub fn get_until(&self) -> Option<&HashSet<H, RandomState>>
Get the until hashes if there are any.
Trait Implementations§
§impl<H> Clone for ChainFilter<H>where
H: Clone + Eq + Ord + Hash,
impl<H> Clone for ChainFilter<H>where H: Clone + Eq + Ord + Hash,
§fn clone(&self) -> ChainFilter<H>
fn clone(&self) -> ChainFilter<H>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<'de, H> Deserialize<'de> for ChainFilter<H>where
H: Eq + Ord + Hash + Deserialize<'de>,
impl<'de, H> Deserialize<'de> for ChainFilter<H>where H: Eq + Ord + Hash + Deserialize<'de>,
§fn deserialize<__D>(
__deserializer: __D
) -> Result<ChainFilter<H>, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>( __deserializer: __D ) -> Result<ChainFilter<H>, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,
§impl<H> PartialEq<ChainFilter<H>> for ChainFilter<H>where
H: PartialEq<H> + Eq + Ord + Hash,
impl<H> PartialEq<ChainFilter<H>> for ChainFilter<H>where H: PartialEq<H> + Eq + Ord + Hash,
§fn eq(&self, other: &ChainFilter<H>) -> bool
fn eq(&self, other: &ChainFilter<H>) -> bool
self
and other
values to be equal, and is used
by ==
.§impl<H> Serialize for ChainFilter<H>where
H: Eq + Ord + Hash + Serialize,
impl<H> Serialize for ChainFilter<H>where H: Eq + Ord + Hash + Serialize,
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,
§impl TryFrom<&ChainFilter<HoloHash<Action>>> for SerializedBytes
impl TryFrom<&ChainFilter<HoloHash<Action>>> for SerializedBytes
§type Error = SerializedBytesError
type Error = SerializedBytesError
§fn try_from(
t: &ChainFilter<HoloHash<Action>>
) -> Result<SerializedBytes, SerializedBytesError>
fn try_from( t: &ChainFilter<HoloHash<Action>> ) -> Result<SerializedBytes, SerializedBytesError>
§impl TryFrom<ChainFilter<HoloHash<Action>>> for SerializedBytes
impl TryFrom<ChainFilter<HoloHash<Action>>> for SerializedBytes
§type Error = SerializedBytesError
type Error = SerializedBytesError
§fn try_from(
t: ChainFilter<HoloHash<Action>>
) -> Result<SerializedBytes, SerializedBytesError>
fn try_from( t: ChainFilter<HoloHash<Action>> ) -> Result<SerializedBytes, SerializedBytesError>
§impl TryFrom<SerializedBytes> for ChainFilter<HoloHash<Action>>
impl TryFrom<SerializedBytes> for ChainFilter<HoloHash<Action>>
§type Error = SerializedBytesError
type Error = SerializedBytesError
§fn try_from(
sb: SerializedBytes
) -> Result<ChainFilter<HoloHash<Action>>, SerializedBytesError>
fn try_from( sb: SerializedBytes ) -> Result<ChainFilter<HoloHash<Action>>, SerializedBytesError>
impl<H> Eq for ChainFilter<H>where H: Eq + Ord + Hash,
impl<H> StructuralEq for ChainFilter<H>where H: Eq + Ord + Hash,
impl<H> StructuralPartialEq for ChainFilter<H>where H: Eq + Ord + Hash,
Auto Trait Implementations§
impl<H> RefUnwindSafe for ChainFilter<H>where H: RefUnwindSafe,
impl<H> Send for ChainFilter<H>where H: Send,
impl<H> Sync for ChainFilter<H>where H: Sync,
impl<H> Unpin for ChainFilter<H>where H: Unpin,
impl<H> UnwindSafe for ChainFilter<H>where H: UnwindSafe,
Blanket Implementations§
§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
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn 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<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn 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 more§fn 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.