Enum elasticsearch_dsl::search::queries::params::PinnedQueryValues

pub enum PinnedQueryValues {
    Ids(BTreeSet<String>),
    Docs(BTreeSet<PinnedDocument>),
}

Ids or documents to filter by

Variants

Ids(BTreeSet<String>)

Document IDs listed in the order they are to appear in results.

Docs(BTreeSet<PinnedDocument>)

Documents listed in the order they are to appear in results.

Implementations

impl PinnedQueryValues

pub fn ids<I>(ids: I) -> Self

where I: IntoIterator, I::Item: ToString,

Creates an instance of PinnedQueryValues with PinnedQueryValues::Ids

pub fn docs<I>(docs: I) -> Self

where I: IntoIterator<Item = PinnedDocument>,

Creates an instance of PinnedQueryValues with PinnedQueryValues::Docs

Trait Implementations

impl Clone for PinnedQueryValues

fn clone(&self) -> PinnedQueryValues

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PinnedQueryValues

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PinnedQueryValues

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for PinnedQueryValues

fn cmp(&self, other: &PinnedQueryValues) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PinnedQueryValues

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PinnedQueryValues

fn partial_cmp(&self, other: &PinnedQueryValues) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PinnedQueryValues

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PinnedQueryValues

impl StructuralEq for PinnedQueryValues

impl StructuralPartialEq for PinnedQueryValues