Struct hdk::prelude::QueryFilter

#[non_exhaustive]pub struct QueryFilter {
    pub sequence_range: Option<Range<u32>>,
    pub entry_type: Option<EntryType>,
    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: Option<Range<u32>>

The range of source chain sequence numbers to match. Inclusive start, exclusive end.

entry_type: Option<EntryType>

Filter by EntryType

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: Range<u32>) -> ChainQueryFilter

Filter on sequence range

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

Filter on entry type

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 check(&self, header: &Header) -> bool

Perform the boolean check which this filter represents

Trait Implementations

impl Clone for ChainQueryFilter

pub fn clone(&self) -> ChainQueryFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainQueryFilter

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

Formats the value using the given formatter.

impl Default for ChainQueryFilter

pub fn default() -> ChainQueryFilter

Returns the “default value” for a type.

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

pub 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

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

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

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

This method tests for !=.

impl Serialize for ChainQueryFilter

pub 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 StructuralPartialEq for ChainQueryFilter

impl<'_> TryFrom<&'_ ChainQueryFilter> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

pub 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.

pub 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.

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

Performs the conversion.