#[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,
}
Expand description
Query arguments
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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
sourceimpl ChainQueryFilter
impl ChainQueryFilter
sourcepub fn new() -> ChainQueryFilter
pub fn new() -> ChainQueryFilter
Create a no-op ChainQueryFilter which returns everything.
sourcepub fn sequence_range(
self,
sequence_range: ChainQueryFilterRange
) -> ChainQueryFilter
pub fn sequence_range(
self,
sequence_range: ChainQueryFilterRange
) -> ChainQueryFilter
Filter on sequence range.
sourcepub fn entry_type(self, entry_type: EntryType) -> ChainQueryFilter
pub fn entry_type(self, entry_type: EntryType) -> ChainQueryFilter
Filter on entry type.
sourcepub fn entry_hashes(
self,
entry_hashes: HashSet<HoloHash<Entry>, RandomState>
) -> ChainQueryFilter
pub fn entry_hashes(
self,
entry_hashes: HashSet<HoloHash<Entry>, RandomState>
) -> ChainQueryFilter
Filter on entry hashes.
sourcepub fn header_type(self, header_type: HeaderType) -> ChainQueryFilter
pub fn header_type(self, header_type: HeaderType) -> ChainQueryFilter
Filter on header type.
sourcepub fn include_entries(self, include_entries: bool) -> ChainQueryFilter
pub fn include_entries(self, include_entries: bool) -> ChainQueryFilter
Include the entries in the ElementsVec that is returned.
sourcepub fn disambiguate_forks(
&self,
headers: Vec<HoloHashed<Header>, Global>
) -> Vec<HoloHashed<Header>, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn disambiguate_forks(
&self,
headers: Vec<HoloHashed<Header>, Global>
) -> Vec<HoloHashed<Header>, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
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.
Trait Implementations
sourceimpl Clone for ChainQueryFilter
impl Clone for ChainQueryFilter
sourcefn clone(&self) -> ChainQueryFilter
fn clone(&self) -> ChainQueryFilter
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ChainQueryFilter
impl Debug for ChainQueryFilter
sourceimpl Default for ChainQueryFilter
impl Default for ChainQueryFilter
sourcefn default() -> ChainQueryFilter
fn default() -> ChainQueryFilter
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for ChainQueryFilter
impl<'de> Deserialize<'de> for ChainQueryFilter
sourcefn deserialize<__D>(
__deserializer: __D
) -> Result<ChainQueryFilter, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<ChainQueryFilter, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<ChainQueryFilter> for ChainQueryFilter
impl PartialEq<ChainQueryFilter> for ChainQueryFilter
sourcefn eq(&self, other: &ChainQueryFilter) -> bool
fn eq(&self, other: &ChainQueryFilter) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ChainQueryFilter) -> bool
fn ne(&self, other: &ChainQueryFilter) -> bool
This method tests for !=
.
sourceimpl Serialize for ChainQueryFilter
impl Serialize for ChainQueryFilter
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,
Serialize this value into the given Serde serializer. Read more
sourceimpl<'_> TryFrom<&'_ ChainQueryFilter> for SerializedBytes
impl<'_> TryFrom<&'_ ChainQueryFilter> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
sourcefn try_from(
t: &ChainQueryFilter
) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(
t: &ChainQueryFilter
) -> Result<SerializedBytes, SerializedBytesError>
Performs the conversion.
sourceimpl TryFrom<ChainQueryFilter> for SerializedBytes
impl TryFrom<ChainQueryFilter> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
sourcefn try_from(
t: ChainQueryFilter
) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(
t: ChainQueryFilter
) -> Result<SerializedBytes, SerializedBytesError>
Performs the conversion.
sourceimpl TryFrom<SerializedBytes> for ChainQueryFilter
impl TryFrom<SerializedBytes> for ChainQueryFilter
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
sourcefn try_from(
sb: SerializedBytes
) -> Result<ChainQueryFilter, SerializedBytesError>
fn try_from(
sb: SerializedBytes
) -> Result<ChainQueryFilter, SerializedBytesError>
Performs the conversion.
impl StructuralPartialEq for ChainQueryFilter
Auto Trait Implementations
impl RefUnwindSafe for ChainQueryFilter
impl Send for ChainQueryFilter
impl Sync for ChainQueryFilter
impl Unpin for ChainQueryFilter
impl UnwindSafe for ChainQueryFilter
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more