Module settings_write 

The comment-preserving writer behind the settings editor.

An edit names a catalogue pattern and the concrete path it fills; the pattern says where the item sits, so a display path with dots in a name is never re-parsed as TOML. One pass applies every edit to the current text, and the caller validates the candidate with the boot loader before it replaces the file.

Re-exports

use forge_primitives::settings::EditKind; 🔒

use forge_primitives::settings::SettingsDocument; 🔒

use forge_primitives::settings::SettingsEdit; 🔒

use forge_primitives::settings::SettingsEditOp; 🔒

use forge_primitives::settings::SettingsEditRequest; 🔒

use forge_primitives::settings::SettingsKey; 🔒

use toml_edit::Array; 🔒

use toml_edit::ArrayOfTables; 🔒

use toml_edit::DocumentMut; 🔒

use toml_edit::InlineTable; 🔒

use toml_edit::Item; 🔒

use toml_edit::Table; 🔒

use toml_edit::Value; 🔒

Structs

WriteError 🔒

Why an edit could not be applied.

Enums

Container 🔒

The container a leaf’s parent is: a table, or an inline table (model_slugs = { ... }).

Part 🔒

Step 🔒

One step into the document.

Functions

add_entry 🔒

Add a whole entry: an account, a project under an org, a Slack workspace, or a model table.

apply 🔒

Apply every edit to the current text.

apply_one 🔒

array_step 🔒

build 🔒

Turn one set of instance names into steps, and rebuild the path they should produce.

descend 🔒

descend_from 🔒

entry_table 🔒

Apply an entry’s fields to a fresh table.

find_key 🔒

identity_pattern 🔒

The catalogue pattern of an edit when it is one of the fields that names its entry, which a batch must apply after the edit’s other changes.

invalid 🔒

item_suffix 🔒

The trailing comment a value carries on its own line.

json_item 🔒

keep_prefix 🔒

Put a leftover entry’s comments at the end of the table that held the array, so an only-entry removal keeps them.

keep_suffix 🔒

Append text to a table’s own trailing decor.

key_text 🔒

The comments and whitespace a table entry’s key carries before it.

locate 🔒

Where a leaf sits: the steps to its parent and the leaf’s own key.

locate_from_group 🔒

The split from the row’s group, accepted only when it rebuilds the row’s own path.

locate_from_path 🔒

The split read off the row’s path: each wildcard takes the shortest name that lets the rest of the pattern match, so the pattern’s literal segments anchor it.

match_path 🔒

Match a pattern against a display path, shortest wildcard names first, and collect the instance names in wildcard order.

match_pattern 🔒

Whether path fills pattern, and the instance names it took. The catalogue’s own matcher, so a key the config does not set can still be resolved back to the pattern that would write it.

next_key_after 🔒

The key after key in the table’s own order, before it is removed.

parts_of 🔒

place_root_prefix 🔒

Put a departed table’s comments above the next root entry, or at the document’s end when it was the last one.

project_path 🔒

The org and project a project entry path names, matched against the document’s own org names: an org name containing dots (or the literal .projects.) cannot be cut short by a split.

remove_entry 🔒

Remove a whole entry.

remove_entry_at 🔒

Remove one table from an array of tables, moving its comments onto the entry that follows (or the previous entry’s trailing text when it was last) so a removal does not take the reader’s notes with it. A prefix with nowhere to go - the array’s only entry - is handed back for the parent table to carry.

remove_key 🔒

remove_leaf 🔒

set_item_value 🔒

set_key 🔒

split_then 🔒

Try each dot boundary of path as a wildcard name, shortest first, and keep the name only when the rest of the pattern matches.

strip_prefix 🔒

to_toml 🔒

Convert a JSON value to the TOML shape its edit kind names.

validate 🔒

Validate one value against a key’s edit spec without applying it, so a tool can refuse a wrong type before it asks the reader anything.