MappingDocument

Struct MappingDocument 

Source
pub struct MappingDocument(/* private fields */);
Expand description

A wrapper around the generated Elasticsearch mapping JSON.

This struct contains the complete mapping definition including the "mappings" root object with its "properties" field.

§Example

use elastic_mapping::{Document, MappingObject};

#[derive(Document)]
struct MyDoc {
    field: String,
}

let mapping = MyDoc::document_mapping();
let json = mapping.inner();
println!("{}", serde_json::to_string_pretty(json).unwrap());

Implementations§

Source§

impl MappingDocument

Source

pub fn inner(&self) -> &Value

Returns a reference to the inner JSON value.

The JSON structure follows Elasticsearch’s mapping format:

{
  "mappings": {
    "properties": { ... }
  }
}
Source

pub fn into_inner(self) -> Value

Consumes the wrapper and returns the inner JSON value.

Trait Implementations§

Source§

impl Debug for MappingDocument

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.