Struct ChainFilter 

pub struct ChainFilter<H = HoloHash<Action>>
where
    H: Eq + Ord + Hash,
{
    pub chain_top: H,
    pub limit_conditions: LimitConditions<H>,
    pub include_cached_entries: bool,
}

Filter the contiguous chain of actions from an agent’s source chain.

Starting from a specified chain_top ActionHash, the filter walks backwards through the linear chain path, towards genesis, excluding any forked actions, and bounded by the specified LimitConditions.

Fields

chain_top: H

The starting position of the filter.

limit_conditions: LimitConditions<H>

The limit conditions used by this filter. Defaults to LimitConditions::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,

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(chain_top: H, n: u32) -> ChainFilter<H>

Create a filter with a take limit.

pub fn include_cached_entries(self) -> ChainFilter<H>

Set this filter to include any cached entries at the agent activity authority.

pub fn until_timestamp(chain_top: H, timestamp: Timestamp) -> ChainFilter<H>

Create a filter with an until-timestamp limit.

pub fn until_hash(chain_top: H, action_hash: H) -> ChainFilter<H>

Create a filter with an until-hash limit.

pub fn get_until_hash(&self) -> Option<&H>

Get the until hash if there is one.

pub fn get_take(&self) -> Option<u32>

Get the take number if there is one.

pub fn get_until_timestamp(&self) -> Option<Timestamp>

Get the take number if there is one.

Trait Implementations

impl<H> Clone for ChainFilter<H>

where H: Clone + Eq + Ord + Hash,

fn clone(&self) -> ChainFilter<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H> Debug for ChainFilter<H>

where H: Debug + Eq + Ord + Hash,

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

Formats the value using the given formatter.

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>,

Deserialize this value from the given Serde deserializer.

impl<H> Eq for ChainFilter<H>

where H: Eq + Ord + Hash,

impl<H> Hash for ChainFilter<H>

where H: Hash + Eq + Ord,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<H> PartialEq for ChainFilter<H>

where H: PartialEq + Eq + Ord + Hash,

fn eq(&self, other: &ChainFilter<H>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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,

Serialize this value into the given Serde serializer.

impl<H> StructuralPartialEq for ChainFilter<H>

where H: PartialEq + Eq + Ord + Hash,

impl TryFrom<&ChainFilter> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &ChainFilter) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<ChainFilter> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: ChainFilter) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for ChainFilter

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<ChainFilter, SerializedBytesError>

Performs the conversion.