Struct AAM 

pub struct AAM { /* private fields */ }

The main AAM configuration store.

Holds the final, validated output of the AAM pipeline, including the key-value map, schemas, and registered types.

Implementations

impl AAM

pub fn new() -> Self

Creates an empty dynamic AAM document.

pub fn parse(text: &str) -> Result<Self, Vec<AamlError>>

Parses an AAM string using the default Pipeline and returns a new AAM instance.

If text is a path to an existing file on disk, it is loaded and parsed dynamically (with full schema support), bypassing the AOT cache. Otherwise, text is treated as raw AAM content.

Errors

Returns errors if the file cannot be read, the content fails to parse, or validation fails.

pub fn from_pipeline( pipeline: &Pipeline, text: &str, ) -> Result<Self, Vec<AamlError>>

Creates an AAM instance from a custom configured Pipeline. Use this if you need to register custom commands, parsers, or validators.

If text is a path to an existing file on disk, it is loaded and parsed as a file. Otherwise, text is treated as raw AAM content.

Errors

Returns errors if the file cannot be read, the content fails to parse, or validation fails.

pub fn load(path: impl AsRef<Path>) -> Result<Self, Vec<AamlError>>

Loads an .aam file from disk.

With aot enabled (default), this uses the cooked .aam.bin cache as the primary path and only invokes parsing/cooking when the cache is missing/stale. This provides zero-copy memory mapping without any allocations.

Errors

Returns errors if the file cannot be read, the cache cannot be memory-mapped, or the content fails to parse/validate.

pub fn format( &self, content: &str, options: &FormattingOptions, ) -> Result<String, AamlError>

Formats arbitrary AAM content using parser + pipeline formatter.

Errors

Returns errors if parsing or formatting fails.

pub fn format_range( &self, content: &str, range: FormatRange, options: &FormattingOptions, ) -> Result<String, AamlError>

Formats only a selected line range of arbitrary AAM content.

Errors

Returns errors if parsing or formatting fails.

pub fn lsp_assist(content: &str, options: &FormattingOptions) -> AamLspAssist

Convenience method for LSP servers: parse with recovery and optional formatting result.

pub fn cook(path: impl AsRef<Path>) -> Result<PathBuf, Vec<AamlError>>

Explicitly cooks an .aam file into .aam.bin cache.

Errors

Returns errors if the file cannot be read, the cache cannot be created, or the content fails to parse/validate.

pub fn load_fast(path: impl AsRef<Path>) -> Result<MappedAam, Vec<AamlError>>

Exposes zero-copy fast loading for advanced runtime integrations.

Errors

Returns errors if the file cannot be read, the cache cannot be memory-mapped, or the source file is invalid and rebuilding fails.

pub fn deep_search(&self, pattern: &str) -> Vec<(&str, &str)>

Deep Search: Finds all key-value pairs where the key contains the specified pattern.

pub fn reverse_search(&self, target_value: &str) -> Vec<&str>

Reverse Search: Finds all keys that match the specified target value.

pub fn find_by<F>(&self, predicate: F) -> Vec<(&str, &str)>

where F: Fn(&str, &str) -> bool,

Advanced search using a custom predicate function.

pub fn find<'a>(&'a self, query: &'a str) -> Vec<(&'a str, &'a str)>

Find by key or value with fallback. First tries to find exactly by key (O(1) lookup), if not found, searches for matching values (O(N) iteration).

pub fn get(&self, key: &str) -> Option<&str>

Retrieves a string value by its key. Performs an O(1) lookup. When AOT is enabled, this is a zero-copy operation straight from the memory-mapped file.

pub fn iter(&self) -> Box<dyn Iterator<Item = (&str, &str)> + '_>

Iterates over all key-value pairs without allocating memory. Supports both dynamic HashMaps and memory-mapped AOT iterators.

pub fn keys(&self) -> Vec<&str>

Returns all keys currently stored. Prefer AAM::iter for zero-allocation iteration.

pub fn to_map(&self) -> PipelineHashMap<String, String>

Returns all key-value pairs as a standard allocated map. Prefer AAM::iter for zero-allocation iteration.

pub const fn schemas(&self) -> Option<&PipelineHashMap<SmolStr, SchemaInfo>>

Returns a reference to all registered schemas, if loaded dynamically. Returns None if the configuration was loaded via an AOT memory map.

pub fn get_schema(&self, name: &str) -> Option<&SchemaInfo>

Returns a specific schema by name, if it exists and was loaded dynamically.

pub const fn types(&self) -> Option<&PipelineHashMap<SmolStr, TypeInfo>>

Returns a reference to all registered types, if loaded dynamically. Returns None if the configuration was loaded via an AOT memory map.

pub fn get_type(&self, name: &str) -> Option<&TypeInfo>

Returns a specific type info by name, if it exists and was loaded dynamically.

Trait Implementations

impl Debug for AAM

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

Formats the value using the given formatter.

impl Default for AAM

fn default() -> Self

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a AAM

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (&'a str, &'a str)> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.