Struct elasticsearch_dsl::search::scripting::Script

pub struct Script { /* fields omitted */ }

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 new() -> Self

Creates an instance of a Script

pub fn lang(self, lang: impl Into<ScriptLang>) -> Self

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

pub fn source(self, source: impl Into<String>) -> Self

The script itself, which you specify as source for an inline script.

pub fn id(self, id: impl Into<String>) -> Self

The script itself, which you specify as id for a stored script. Use the stored script APIs to create and manage stored scripts.

pub fn param<T>(self, name: impl Into<String>, param: T) -> Self where
    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 Default for Script

fn default() -> Script

Returns the “default value” for a type.

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: &Script) -> bool

This method tests for !=.

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 StructuralPartialEq for Script