Struct elastic_types::boolean::prelude::Boolean

pub struct Boolean<TMapping> where
    TMapping: BooleanMapping,  { /* fields omitted */ }

An Elasticsearch boolean with a mapping.

Where the mapping isn't custom, you can use the standard library bool instead.

Examples

Defining a bool with a mapping:

let boolean = Boolean::<DefaultBooleanMapping>::new(true);

Methods

impl<TMapping> Boolean<TMapping> where
    TMapping: BooleanMapping, 

pub fn new<I>(boolean: I) -> Boolean<TMapping> where
    I: Into<bool>, 

Creates a new Boolean with the given mapping.

Examples

Create a new Boolean from a bool:

let boolean = Boolean::<DefaultBooleanMapping>::new(false);

pub fn remap<TNewMapping>(boolean: Boolean<TMapping>) -> Boolean<TNewMapping> where
    TNewMapping: BooleanMapping, 

Change the mapping of this boolean.

Examples

Change the mapping for a given Boolean:

let boolean = Boolean::<DefaultBooleanMapping>::new(true);

let boolean: Boolean<MyBooleanMapping> = Boolean::remap(boolean);

Trait Implementations

impl<TMapping> BooleanFieldType<TMapping> for Boolean<TMapping> where
    TMapping: BooleanMapping, 

impl<TMapping: Default> Default for Boolean<TMapping> where
    TMapping: BooleanMapping, 

fn default() -> Boolean<TMapping>

Returns the "default value" for a type.

impl<TMapping: PartialEq> PartialEq<Boolean<TMapping>> for Boolean<TMapping> where
    TMapping: BooleanMapping, 

fn eq(&self, other: &Boolean<TMapping>) -> bool

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

fn ne(&self, other: &Boolean<TMapping>) -> bool

This method tests for !=.

impl<M> PartialEq<bool> for Boolean<M> where
    M: BooleanMapping, 

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

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

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

This method tests for !=.

impl<M> PartialEq<Boolean<M>> for bool where
    M: BooleanMapping, 

fn eq(&self, other: &Boolean<M>) -> bool

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

fn ne(&self, other: &Boolean<M>) -> bool

This method tests for !=.

impl<M> From<bool> for Boolean<M> where
    M: BooleanMapping, 

fn from(value: bool) -> Self

Performs the conversion.

impl<TMapping: Clone> Clone for Boolean<TMapping> where
    TMapping: BooleanMapping, 

fn clone(&self) -> Boolean<TMapping>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Deref for Boolean<M> where
    M: BooleanMapping, 

type Target = bool

The resulting type after dereferencing.

fn deref(&self) -> &bool

Dereferences the value.

impl<TMapping: Debug> Debug for Boolean<TMapping> where
    TMapping: BooleanMapping, 

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

Formats the value using the given formatter.

impl<M> Borrow<bool> for Boolean<M> where
    M: BooleanMapping, 

fn borrow(&self) -> &bool

Immutably borrows from an owned value.

impl<TMapping> Serialize for Boolean<TMapping> where
    TMapping: BooleanMapping, 

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

Serialize this value into the given Serde serializer.

impl<'de, TMapping> Deserialize<'de> for Boolean<TMapping> where
    TMapping: BooleanMapping, 

fn deserialize<D>(deserializer: D) -> Result<Boolean<TMapping>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.