Skip to content

ludus::foundation::config::Context

Ludus Wiki · API overview · Browse API

Class

One control owner.
Read/prepare/commit are not a concurrent facade. Consumers copy their typed options at a safe point. Prepare is side-effect-free; commit allocates nothing and calls no user code. No runtime I/O or global service.

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

#include <ludus/foundation/config/config.hpp>
class ludus::foundation::config::Context final

Methods

Context

ludus::foundation::config::Context::Context() noexcept=default

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

~Context

ludus::foundation::config::Context::~Context() noexcept

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Context

ludus::foundation::config::Context::Context(const Context &)=delete

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

operator=

Context & ludus::foundation::config::Context::operator=(const Context &)=delete

Related types: Context

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Initialize

Status ludus::foundation::config::Context::Initialize(std::span< const Descriptor > schema, const AllocationDomain &domain, Diagnostic &error, const Limits &limits={}, ValidateFunction validate=nullptr, void *validationContext=nullptr) noexcept

Related types: AllocationDomain · ValidateFunction · Status · Descriptor · Diagnostic · Limits

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

IsValid

bool ludus::foundation::config::Context::IsValid() const noexcept

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Revision

uint64 ludus::foundation::config::Context::Revision() const noexcept

Related types: uint64

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Schema

std::span< const Descriptor > ludus::foundation::config::Context::Schema() const noexcept

Related types: Descriptor

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Bind

Status ludus::foundation::config::Context::Bind(std::string_view name, Binding &output) const noexcept

Related types: Status · Binding

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Explain

Status ludus::foundation::config::Context::Explain(Binding binding, Explanation &output) const noexcept

Related types: Status · Binding · Explanation

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

ReadLayer

Status ludus::foundation::config::Context::ReadLayer(Binding binding, Layer layer, Value &output, Origin &origin) const noexcept

Related types: Layer · Status · Binding · Origin · Value

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Prepare

Status ludus::foundation::config::Context::Prepare(Layer layer, std::span< const Assignment > edits, bool replace, uint64 expectedRevision, Diagnostic &error) noexcept
Replace clears that entire layer in the candidate; patch changes only the specified keys.
All assignments, including masked values, are checked.

Related types: Layer · Status · uint64 · Assignment · Diagnostic

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

ReadPrepared

Status ludus::foundation::config::Context::ReadPrepared(Binding binding, Value &output) const noexcept

Related types: Status · Binding · Value

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Commit

Status ludus::foundation::config::Context::Commit(uint64 expectedRevision, Diagnostic &error) noexcept

Related types: Status · uint64 · Diagnostic

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

Discard

void ludus::foundation::config::Context::Discard() noexcept

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp

SealStartup

Status ludus::foundation::config::Context::SealStartup() noexcept
Subsequent restart-only changes become requested/pending; simulation settings freeze.
Called after initial options reach their native owners.

Related types: Status

Declared in modules/foundation/config/include/ludus/foundation/config/config.hpp