Enum elasticsearch_dsl::search::params::SourceFilter

pub enum SourceFilter {
    Enable(bool),
    Include(String),
    Includes(Vec<String>),
    IncludesExcludes {
        includes: Vec<String>,
        excludes: Vec<String>,
    },
}

Control how the _source field is returned with every hit.

By default operations return the contents of the _source field unless you have used the stored_fields parameter or if the _source field is disabled.

Variants

Enable(bool)

Tuple Fields

0: bool

Whether _source retrieval should be enabled (true) or disabled (false)

Include(String)

Tuple Fields

0: String

A wildcard pattern to control what parts of _source should be returned

Includes(Vec<String>)

Tuple Fields

0: Vec<String>

A collection of wildcard patterns to control what parts of _source should be returned

IncludesExcludes

Fields

includes: Vec<String>

A collection of wildcard patterns to control what parts of _source should be returned

excludes: Vec<String>

A collection of wildcard patterns to control what parts of _source should not be returned

A collection of wildcard patterns to control what parts of _source should and should not be returned

Trait Implementations

impl Clone for SourceFilter

fn clone(&self) -> SourceFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFilter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceFilter

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

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a str> for SourceFilter

fn from(include: &'a str) -> Self

Performs the conversion.

impl<'a, const N: usize> From<[&'a str; N]> for SourceFilter

fn from(includes: [&'a str; N]) -> Self

Performs the conversion.

impl<const N: usize> From<[String; N]> for SourceFilter

fn from(includes: [String; N]) -> Self

Performs the conversion.

impl<'a> From<(Vec<&'a str, Global>, Vec<&'a str, Global>)> for SourceFilter

fn from(includes_excludes: (Vec<&'a str>, Vec<&'a str>)) -> Self

Performs the conversion.

impl From<(Vec<String, Global>, Vec<String, Global>)> for SourceFilter

fn from(includes_excludes: (Vec<String>, Vec<String>)) -> Self

Performs the conversion.

impl From<String> for SourceFilter

fn from(include: String) -> Self

Performs the conversion.

impl<'a> From<Vec<&'a str, Global>> for SourceFilter

fn from(includes: Vec<&'a str>) -> Self

Performs the conversion.

impl From<Vec<String, Global>> for SourceFilter

fn from(includes: Vec<String>) -> Self

Performs the conversion.

impl From<bool> for SourceFilter

fn from(b: bool) -> Self

Performs the conversion.

impl PartialEq<SourceFilter> for SourceFilter

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

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

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

This method tests for !=.

impl Serialize for SourceFilter

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SourceFilter