Struct hdi::prelude::chain::ChainFilter
source · 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
sourceimpl<H> ChainFilter<H>where
H: Eq + Ord + Hash,
impl<H> ChainFilter<H>where
H: Eq + Ord + Hash,
sourcepub 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
.
sourcepub 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.
sourcepub 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.
sourcepub 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.
sourcepub 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
sourceimpl<H> Clone for ChainFilter<H>where
H: Clone + Eq + Ord + Hash,
impl<H> Clone for ChainFilter<H>where
H: Clone + Eq + Ord + Hash,
sourcefn clone(&self) -> ChainFilter<H>
fn clone(&self) -> ChainFilter<H>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'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>,
sourcefn 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>,
sourceimpl<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,
sourcefn eq(&self, other: &ChainFilter<H>) -> bool
fn eq(&self, other: &ChainFilter<H>) -> bool
sourceimpl<H> Serialize for ChainFilter<H>where
H: Eq + Ord + Hash + Serialize,
impl<H> Serialize for ChainFilter<H>where
H: Eq + Ord + Hash + Serialize,
sourcefn 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,
sourceimpl TryFrom<&ChainFilter<HoloHash<Action>>> for SerializedBytes
impl TryFrom<&ChainFilter<HoloHash<Action>>> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
sourcefn try_from(
t: &ChainFilter<HoloHash<Action>>
) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(
t: &ChainFilter<HoloHash<Action>>
) -> Result<SerializedBytes, SerializedBytesError>
sourceimpl TryFrom<ChainFilter<HoloHash<Action>>> for SerializedBytes
impl TryFrom<ChainFilter<HoloHash<Action>>> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
sourcefn try_from(
t: ChainFilter<HoloHash<Action>>
) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(
t: ChainFilter<HoloHash<Action>>
) -> Result<SerializedBytes, SerializedBytesError>
sourceimpl TryFrom<SerializedBytes> for ChainFilter<HoloHash<Action>>
impl TryFrom<SerializedBytes> for ChainFilter<HoloHash<Action>>
type Error = SerializedBytesError
type Error = SerializedBytesError
sourcefn 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
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>
sourceimpl<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,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.