Struct Mapping 

pub struct Mapping { /* private fields */ }

An ordered set of field mappings with name-to-ID lookup.

Fields are assigned sequential FieldIds starting at 0. The schema is immutable after construction — new fields are added by building a new schema that extends the previous one (see schema evolution in [[architecture-api-surface#Schema Evolution]]).

See [[architecture-api-surface#Schema Definition]].

Implementations

impl Mapping

pub fn builder() -> MappingBuilder

Start building a schema.

pub fn ensure_id_field(&mut self)

Ensure the _id field exists, appending it if needed. Called by Index at creation time. See [[feature-document-crud]].

pub fn field_id(&self, name: &str) -> Option<FieldId>

Look up a field’s ID by name.

pub fn field(&self, id: FieldId) -> &FieldMapping

Get a field mapping by ID.

Panics

Panics if id is out of bounds.

pub fn fields(&self) -> &[FieldMapping]

All field mappings in insertion order.

pub fn len(&self) -> usize

Number of fields.

pub fn is_empty(&self) -> bool

Whether the schema has no fields.

pub fn dynamic_mode(&self) -> DynamicMode

How unknown fields are handled.

pub fn validate(&self) -> Result<()>

Validate cross-field references (currently: copy_to targets).

Returns an error if any field’s copy_to references a target name that does not exist in the schema. Without this check the writer would silently skip the copy at index time, leaving the user with no signal that their configuration is a no-op — see [[code-must-not-lie]].

Called automatically by Mapping::from_json; programmatic builder users should call it (or rely on Index::create_with_mapping to call it on their behalf).

pub fn to_json(&self) -> Value

Serialize to ES-compatible JSON mapping format.

Produces {"mappings": {"dynamic": "...", "properties": {...}}}.

pub fn from_json(json: &Value) -> Result<Self>

Parse from ES-compatible JSON mapping format.

Accepts {"mappings": {"properties": {...}}} or the shorthand {"properties": {...}}.

Errors

Returns LuciError::InvalidQuery if the JSON structure is invalid or contains unsupported field types.

Trait Implementations

impl Clone for Mapping

fn clone(&self) -> Mapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mapping

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

Formats the value using the given formatter.