Struct hdk::prelude::query::ChainQueryFilter

#[non_exhaustive]
pub struct ChainQueryFilter {
    pub sequence_range: ChainQueryFilterRange,
    pub entry_type: Option<EntryType>,
    pub entry_hashes: Option<HashSet<HoloHash<Entry>, RandomState>>,
    pub header_type: Option<HeaderType>,
    pub include_entries: bool,
}

Query arguments

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sequence_range: ChainQueryFilterRange

Limit the results to a range of elements according to their headers.

entry_type: Option<EntryType>

Filter by EntryType

entry_hashes: Option<HashSet<HoloHash<Entry>, RandomState>>

Filter by a list of EntryHash.

header_type: Option<HeaderType>

Filter by HeaderType

include_entries: bool

Include the entries in the elements

Implementations

impl ChainQueryFilter

pub fn new() -> ChainQueryFilter

Create a no-op ChainQueryFilter which returns everything.

pub fn sequence_range(
    self,
    sequence_range: ChainQueryFilterRange
) -> ChainQueryFilter

Filter on sequence range.

pub fn entry_type(self, entry_type: EntryType) -> ChainQueryFilter

Filter on entry type.

pub fn entry_hashes(
    self,
    entry_hashes: HashSet<HoloHash<Entry>, RandomState>
) -> ChainQueryFilter

Filter on entry hashes.

pub fn header_type(self, header_type: HeaderType) -> ChainQueryFilter

Filter on header type.

pub fn include_entries(self, include_entries: bool) -> ChainQueryFilter

Include the entries in the ElementsVec that is returned.

pub fn disambiguate_forks(
    &self,
    headers: Vec<HoloHashed<Header>, Global>
) -> Vec<HoloHashed<Header>, Global>

If the sequence range supports fork disambiguation, apply it to remove headers that are not in the correct branch. Numerical range bounds do NOT support fork disambiguation, and neither does unbounded, but everything hash bounded does.

pub fn filter_headers(
    &self,
    headers: Vec<HoloHashed<Header>, Global>
) -> Vec<HoloHashed<Header>, Global>

Filter a vector of hashed headers according to the query.

pub fn filter_elements(
    &self,
    elements: Vec<Element, Global>
) -> Vec<Element, Global>

Filter a vector of elements according to the query.

Trait Implementations

impl Clone for ChainQueryFilter

fn clone(&self) -> ChainQueryFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainQueryFilter

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

Formats the value using the given formatter.

impl Default for ChainQueryFilter

fn default() -> ChainQueryFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChainQueryFilter

fn deserialize<__D>(
    __deserializer: __D
) -> Result<ChainQueryFilter, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ChainQueryFilter> for ChainQueryFilter

fn eq(&self, other: &ChainQueryFilter) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for ChainQueryFilter

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<'_> TryFrom<&'_ ChainQueryFilter> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ChainQueryFilter> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for ChainQueryFilter

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for ChainQueryFilter