aam-rs 2.0.2

A Rust implementation of the Abstract Alias Mapping (AAM) framework for aliasing and maping aam files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Public API (Python)

Source of truth: `src/python.rs` (PyO3 class exported as `aam_py.AAM`).

## Main Class

- `AAM`
- `AAMBuilder`
- `SchemaField`

## Construction

- `AAM()`
- `AAM.parse(content: str) -> AAM`
- `AAM.load(path: str) -> AAM`

## Utility Static Method

- `AAM.lsp_assist(content: str) -> tuple[list[str], str | None]`

## Instance Methods

- `format(content: str) -> str`
- `format_range(content: str, start_line: int, end_line: int) -> str`
- `get(key: str) -> str | None`
- `keys() -> list[str]`
- `to_dict() -> dict[str, str]`
- `find(query: str) -> dict[str, str]`
- `deep_search(pattern: str) -> dict[str, str]`
- `reverse_search(target_value: str) -> list[str]`
- `schema_names() -> list[str]`
- `type_names() -> list[str]`
- `close() -> None`
- `is_closed() -> bool`

## Python Protocol Methods

- `__repr__`, `__len__`, `__contains__`, `__getitem__`

## Builder API

- `SchemaField.required(name: str, type_name: str) -> SchemaField`
- `SchemaField.optional(name: str, type_name: str) -> SchemaField`
- `AAMBuilder()`
- `AAMBuilder.with_capacity(capacity: int) -> AAMBuilder`
- `add_line(key: str, value: str) -> None`
- `comment(text: str) -> None`
- `schema(name: str, fields: list[SchemaField]) -> None`
- `schema_multiline(name: str, fields: list[SchemaField]) -> None`
- `derive(path: str, schemas: list[str]) -> None`
- `import(path: str) -> None`
- `type_alias(alias: str, type_name: str) -> None`
- `as_string() -> str`