Struct elastic_types::string::Keyword
[−]
[src]
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,
[src]
TMapping: KeywordMapping,
fn new<I>(string: I) -> Keyword<TMapping> where
I: Into<String>,
[src]
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");
fn remap<TNewMapping>(keyword: Keyword<TMapping>) -> Keyword<TNewMapping> where
TNewMapping: KeywordMapping,
[src]
TNewMapping: KeywordMapping,
Change the mapping of this string.
Methods from Deref<Target = String>
fn into_bytes(self) -> Vec<u8>
1.0.0[src]
Converts a String
into a byte vector.
This consumes the String
, so we do not need to copy its contents.
Examples
Basic usage:
let s = String::from("hello"); let bytes = s.into_bytes(); assert_eq!(&[104, 101, 108, 108, 111][..], &bytes[..]);
fn as_str(&self) -> &str
1.7.0[src]
Extracts a string slice containing the entire string.
Examples
Basic usage:
let s = String::from("foo"); assert_eq!("foo", s.as_str());
fn capacity(&self) -> usize
1.0.0[src]
Returns this String
's capacity, in bytes.
Examples
Basic usage:
let s = String::with_capacity(10); assert!(s.capacity() >= 10);
fn as_bytes(&self) -> &[u8]
1.0.0[src]
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());
fn len(&self) -> usize
1.0.0[src]
Returns the length of this String
, in bytes.
Examples
Basic usage:
let a = String::from("foo"); assert_eq!(a.len(), 3);
fn is_empty(&self) -> bool
1.0.0[src]
Returns true
if this String
has a length of zero.
Returns false
otherwise.
Examples
Basic usage:
let mut v = String::new(); assert!(v.is_empty()); v.push('a'); assert!(!v.is_empty());
fn into_boxed_str(self) -> Box<str>
1.4.0[src]
Trait Implementations
impl<TMapping: Debug> Debug for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
impl<TMapping: Clone> Clone for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
fn clone(&self) -> Keyword<TMapping>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<TMapping: Default> Default for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
impl<TMapping: PartialEq> PartialEq for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
fn eq(&self, __arg_0: &Keyword<TMapping>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Keyword<TMapping>) -> bool
[src]
This method tests for !=
.
impl<TMapping> KeywordFieldType<TMapping> for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
impl<M> From<String> for Keyword<M> where
M: KeywordMapping,
[src]
M: KeywordMapping,
impl<M> PartialEq<String> for Keyword<M> where
M: KeywordMapping,
[src]
M: KeywordMapping,
fn eq(&self, other: &String) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &String) -> bool
[src]
This method tests for !=
.
impl<M> Deref for Keyword<M> where
M: KeywordMapping,
[src]
M: KeywordMapping,
type Target = String
The resulting type after dereferencing.
fn deref(&self) -> &String
[src]
Dereferences the value.
impl<M> Borrow<String> for Keyword<M> where
M: KeywordMapping,
[src]
M: KeywordMapping,
impl<TMapping> AsRef<str> for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
impl<'a, TMapping> PartialEq<&'a str> for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
fn eq(&self, other: &&'a str) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &&'a str) -> bool
[src]
This method tests for !=
.
impl<TMapping> Serialize for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
[src]
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<'de, TMapping> Deserialize<'de> for Keyword<TMapping> where
TMapping: KeywordMapping,
[src]
TMapping: KeywordMapping,
fn deserialize<D>(deserializer: D) -> Result<Keyword<TMapping>, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more