Struct elastic_types::string::keyword::prelude::Keyword

pub struct Keyword<TMapping> where
    TMapping: KeywordMapping,  { /* fields omitted */ }

An Elasticsearch keyword with a mapping.

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

Examples

Defining a keyword with a mapping:

use elastic_types::string::keyword::mapping::DefaultKeywordMapping;
use elastic_types::string::keyword::Keyword;

let string = Keyword::<DefaultKeywordMapping>::new("my string value");

Methods

impl<TMapping> Keyword<TMapping> where
    TMapping: KeywordMapping, 

pub fn new<I>(string: I) -> Keyword<TMapping> where
    I: Into<String>, 

Creates a new Keyword with the given mapping.

Examples

Create a new Keyword from a String:

use elastic_types::string::keyword::mapping::DefaultKeywordMapping;
use elastic_types::string::keyword::Keyword;

let string = Keyword::<DefaultKeywordMapping>::new("my string");

pub fn remap<TNewMapping>(keyword: Keyword<TMapping>) -> Keyword<TNewMapping> where
    TNewMapping: KeywordMapping, 

Change the mapping of this string.

Methods from Deref<Target = String>

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire String.

Examples

Basic usage:

let s = String::from("foo");

assert_eq!("foo", s.as_str());

pub fn capacity(&self) -> usize

Returns this String's capacity, in bytes.

Examples

Basic usage:

let s = String::with_capacity(10);

assert!(s.capacity() >= 10);

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice of this String's contents.

The inverse of this method is from_utf8.

Examples

Basic usage:

let s = String::from("hello");

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

pub fn len(&self) -> usize

Returns the length of this String, in bytes.

Examples

Basic usage:

let a = String::from("foo");

assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if this String has a length of zero, and false otherwise.

Examples

Basic usage:

let mut v = String::new();
assert!(v.is_empty());

v.push('a');
assert!(!v.is_empty());

Trait Implementations

impl<TMapping> KeywordFieldType<TMapping> for Keyword<TMapping> where
    TMapping: KeywordMapping, 

impl<TMapping: Default> Default for Keyword<TMapping> where
    TMapping: KeywordMapping, 

fn default() -> Keyword<TMapping>

Returns the "default value" for a type.

impl<TMapping: PartialEq> PartialEq<Keyword<TMapping>> for Keyword<TMapping> where
    TMapping: KeywordMapping, 

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

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

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

This method tests for !=.

impl<M> PartialEq<String> for Keyword<M> where
    M: KeywordMapping, 

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

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

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

This method tests for !=.

impl<M> PartialEq<Keyword<M>> for String where
    M: KeywordMapping, 

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

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

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

This method tests for !=.

impl<'a, TMapping> PartialEq<&'a str> for Keyword<TMapping> where
    TMapping: KeywordMapping, 

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

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

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

This method tests for !=.

impl<'a, TMapping> PartialEq<Keyword<TMapping>> for &'a str where
    TMapping: KeywordMapping, 

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

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

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

This method tests for !=.

impl<M> From<String> for Keyword<M> where
    M: KeywordMapping, 

fn from(value: String) -> Self

Performs the conversion.

impl<'a, TMapping> From<Keyword<TMapping>> for String where
    TMapping: KeywordMapping, 

fn from(wrapper: Keyword<TMapping>) -> Self

Performs the conversion.

impl<'a, TMapping> From<&'a Keyword<TMapping>> for Cow<'a, str> where
    TMapping: KeywordMapping, 

fn from(wrapper: &'a Keyword<TMapping>) -> Self

Performs the conversion.

impl<'a, TMapping> From<Keyword<TMapping>> for Cow<'a, str> where
    TMapping: KeywordMapping, 

fn from(wrapper: Keyword<TMapping>) -> Self

Performs the conversion.

impl<TMapping> AsRef<str> for Keyword<TMapping> where
    TMapping: KeywordMapping, 

fn as_ref(&self) -> &str

Performs the conversion.

impl<TMapping: Clone> Clone for Keyword<TMapping> where
    TMapping: KeywordMapping, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Deref for Keyword<M> where
    M: KeywordMapping, 

type Target = String

The resulting type after dereferencing.

fn deref(&self) -> &String

Dereferences the value.

impl<TMapping: Debug> Debug for Keyword<TMapping> where
    TMapping: KeywordMapping, 

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

Formats the value using the given formatter.

impl<M> Borrow<String> for Keyword<M> where
    M: KeywordMapping, 

fn borrow(&self) -> &String

Immutably borrows from an owned value.

impl<TMapping> Serialize for Keyword<TMapping> where
    TMapping: KeywordMapping, 

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 Keyword<TMapping> where
    TMapping: KeywordMapping, 

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

Deserialize this value from the given Serde deserializer.