Struct elastic::types::prelude::Text
[−]
[src]
pub struct Text<M> where
M: TextMapping, { /* fields omitted */ }
An Elasticsearch text
field with a mapping.
Where the mapping isn't custom, you can use the standard library String
instead.
Examples
Defining a text
field with a mapping:
use elastic_types::string::text::mapping::DefaultTextMapping; use elastic_types::string::text::Text; let string = Text::<DefaultTextMapping>::new("my string value");
Methods
impl<M> Text<M> where
M: TextMapping,
[src]
M: TextMapping,
fn new<I>(string: I) -> Text<M> where
I: Into<String>,
I: Into<String>,
Creates a new Text
with the given mapping.
Examples
Create a new Text
from a String
:
use elastic_types::string::text::mapping::DefaultTextMapping; use elastic_types::string::text::Text; let string = Text::<DefaultTextMapping>::new("my string");
fn remap<MInto>(self) -> Text<MInto> where
MInto: TextMapping,
MInto: TextMapping,
Change the mapping of this string.
Methods from Deref<Target = String>
fn into_bytes(self) -> Vec<u8>
1.0.0
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
Extracts a string slice containing the entire string.
fn capacity(&self) -> usize
1.0.0
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
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
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
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
Converts this String
into a Box<str>
.
This will drop any excess capacity.
Examples
Basic usage:
let s = String::from("hello"); let b = s.into_boxed_str();
Trait Implementations
impl<M> Default for Text<M> where
M: Default + TextMapping,
[src]
M: Default + TextMapping,
impl<M> AsRef<String> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
impl<M> AsRef<str> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
impl<'de, M> Deserialize<'de> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
fn deserialize<D>(
deserializer: D
) -> Result<Text<M>, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
deserializer: D
) -> Result<Text<M>, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
impl<M> Debug for Text<M> where
M: Debug + TextMapping,
[src]
M: Debug + TextMapping,
fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter.
impl<M> Serialize for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<M> From<String> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
impl<M> TextFieldType<M> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
impl<M> PartialEq<String> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
impl<M> PartialEq<Text<M>> for Text<M> where
M: PartialEq<M> + TextMapping,
[src]
M: PartialEq<M> + TextMapping,
impl<'a, M> PartialEq<&'a str> for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
impl<M> Deref for Text<M> where
M: TextMapping,
[src]
M: TextMapping,
type Target = String
The resulting type after dereferencing
fn deref(&self) -> &String
The method called to dereference a value
impl<M> Clone for Text<M> where
M: Clone + TextMapping,
[src]
M: Clone + TextMapping,