Skip to main content

Module settings

Module settings 

Source
Expand description

The effective-config document a server pushes to every client.

One document is built per load and shared by every connection: the areas forge.toml is read into, every key’s effective value, and the class that says when an edit to that key takes effect. Values cross as the file loads them, unredacted - the socket is reached over loopback or the private network, which is the boundary.

Re-exports§

use serde::Deserialize; 🔒
use serde::Deserialize; 🔒
use serde::Serialize; 🔒
use serde::Serialize; 🔒

Structs§

SettingsArea
One area of the config, as the page’s sub-nav lists it.
SettingsDocument
The whole effective config, pushed on attach and after every applied reload.
SettingsEdit
What the editor needs to draw a key’s control and to know which entry it belongs to.
SettingsEditRequest
One edit a client asks the server to apply to forge.toml.
SettingsKey
One key’s effective value and the class that says when a change lands.
SettingsTotals
The header’s own totals, built with the document so a client does not count for itself.
SettingsWriteAsk
One configuration write held for the reader’s approval.
SettingsWriteChange
One key’s change in a held write.

Enums§

EditKind
The control a key’s value is edited with.
EffectClass
When an edit to a key takes effect.
SettingKind
The shape of a key’s value, so a client picks a drawing without guessing from the text.
SettingsEditOp
One change in a batched save.
SettingsWriteEnding
What ended a held write, which a view that did not answer it has no other way to learn.