Struct elasticsearch_dsl::search::queries::params::Script

pub struct Script { /* private fields */ }

Wherever scripting is supported in the Elasticsearch APIs, the syntax follows the same pattern; you specify the language of your script, provide the script logic (or source, and add parameters that are passed into the script.

https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html

Implementations

impl Script

pub fn source<S>(source: S) -> Selfwhere
    S: ToString,

Creates an instance of inlined Script

pub fn id<S>(id: S) -> Selfwhere
    S: ToString,

Creates an instance of stored Script

pub fn lang<S>(self, lang: S) -> Selfwhere
    S: Into<ScriptLang>,

Specifies the language the script is written in. Defaults to painless.

pub fn param<T, S>(self, name: S, param: T) -> Selfwhere
    S: ToString,
    T: Serialize,

Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

Trait Implementations

impl Clone for Script

fn clone(&self) -> Script

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Script

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

Formats the value using the given formatter.

impl PartialEq<Script> for Script

fn eq(&self, other: &Script) -> 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 Serialize for Script

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 Script

impl StructuralEq for Script

impl StructuralPartialEq for Script