Struct TextMap 

pub struct TextMap<S = Root> { /* private fields */ }

A dynamic-key object whose values are analyzed full text (map with a text/identifier value kind). key yields a Text leaf; search runs full text across every key; sort_key orders by a key, with .or(..) fallback.

Implementations

impl<S> TextMap<S>

pub fn at(path: impl Into<String>) -> Self

pub fn has_key(&self, key: impl AsRef<str>) -> Query<S>

The map holds the given key with a non-null value.

pub fn exists(&self) -> Query<S>

The map field itself is present (has at least one key).

impl<S> TextMap<S>

pub fn key(&self, key: impl AsRef<str>) -> Text<S, MapKey>

A specific runtime key → a fully-typed Text leaf, queried like any other text field. It carries the MapKey marker, so it is not directly sortable — order a text map by key with sort_key, which is correct at query time and supports key fallback.

pub fn sort_key(&self, key: impl Into<String>) -> MapKeySort<S>

Sort by this key, with optional fallback — sort_key("it").or("en") orders by it, else en (language fallback). Returns a MapKeySort; pass it to SortBuilder::by or .asc()/.desc().

impl<S> TextMap<S>

pub fn search(&self, query: impl Into<String>) -> MapSearch<S>

Full-text search across every key at once, with optional per-key preference. Returns a MapSearch builder; add prefer to weight a key (e.g. the user’s locale).

Trait Implementations

impl<S: Clone> Clone for TextMap<S>

fn clone(&self) -> TextMap<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for TextMap<S>

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

Formats the value using the given formatter.