Config module of the StormByte suite. More...
Namespaces | |
| namespace | Binary |
| namespace | Item |
| Configuration document items. | |
Classes | |
| class | Config |
| Configuration document (text or versioned binary). More... | |
| class | Exception |
| Root exception for Config. More... | |
| class | WrongValueTypeConversion |
| Thrown when a value is converted to an incorrect type. More... | |
| class | ValueFailure |
| Thrown when setting a value fails due to type mismatch. More... | |
| class | InvalidName |
| Thrown when an invalid name is used for an item. More... | |
| class | InvalidPath |
| Thrown when an invalid path is used for an item. More... | |
| class | ParseError |
| Thrown when a parsing error occurs in a configuration file. More... | |
| class | ItemNotFound |
| Thrown when an item cannot be found by its path or name. More... | |
| class | ItemAlreadyExists |
| Thrown when attempting to add an item that already exists. More... | |
| class | ItemNameAlreadyExists |
| Thrown when an item's name conflicts with an existing name. More... | |
| class | OutOfBounds |
| Thrown when an index is out of bounds. More... | |
Typedefs | |
| using | HookFunctions = StormByte::Safe::Vector<StormByte::Safe::Shared<ReadHook>> |
| Read callbacks owned by Config. | |
| using | OptionalFailureHook = StormByte::Safe::Shared<FailureHook> |
| Optional parse-failure callback. | |
| using | ReadHook = StormByte::Safe::Function<void(StormByte::Safe::Shared<Item::Group>)> |
| Safe read callback receiving a Base-owned mutable group handle. | |
| using | FailureHook = StormByte::Safe::Function<bool(StormByte::Safe::Shared<const Item::Group>)> |
| Safe parse-failure callback receiving a Base-owned read-only group handle. | |
| using | ExpectedConfig = StormByte::Expected<Config, StormByte::Exception> |
| Result of loading a configuration document (text or binary). | |
Enumerations | |
| enum class | OnExistingAction : unsigned short { Keep , Overwrite , ThrowException } |
| Forward declaration of the configuration document. More... | |
| enum class | Mode : unsigned short { Text , Binary } |
| Serialization / deserialization mode for configuration documents. More... | |
Functions | |
| Config & | operator>> (std::istream &istream, Config &file) |
| Initializes configuration when istream is on the left-hand side. | |
| Config & | operator>> (std::string_view str, Config &file) |
| Initializes configuration when text is on the left-hand side. | |
| std::ostream & | operator<< (std::ostream &ostream, const Config &file) |
| Output configuration when ostream is on the left-hand side. | |
| std::string & | operator<< (std::string &str, const Config &file) |
| Output configuration when string is on the left-hand side. | |
| template<typename Callable> requires StormByte::Type::CopyConstructible<std::remove_cvref_t<Callable>> | |
| ReadHook | MakeReadHook (Callable &&callable) |
| Creates a read hook whose callable context is cloned and released by its creator. | |
| template<typename Callable> requires StormByte::Type::CopyConstructible<std::remove_cvref_t<Callable>> | |
| FailureHook | MakeFailureHook (Callable &&callable) |
| Creates a failure hook whose callable context is cloned and released by its creator. | |
Result of loading a configuration document (text or binary).
On failure, the error is a StormByte::Exception derivative (for example ParseError or StormByte::DeserializeError).
| using StormByte::Config::FailureHook = StormByte::Safe::Function<bool(StormByte::Safe::Shared<const Item::Group>)> |
Safe parse-failure callback receiving a Base-owned read-only group handle.
Read callbacks owned by Config.
Optional parse-failure callback.
| using StormByte::Config::ReadHook = StormByte::Safe::Function<void(StormByte::Safe::Shared<Item::Group>)> |
Safe read callback receiving a Base-owned mutable group handle.
|
strong |
Serialization / deserialization mode for configuration documents.
Selects whether a document is exchanged as human-readable text (the classic StormByte config syntax) or as the versioned binary wire format.
| Enumerator | |
|---|---|
| Text | Human-readable configuration syntax (UTF-8 text). |
| Binary | Versioned binary format (magic + format version + payload). |
|
strong |
| FailureHook StormByte::Config::MakeFailureHook | ( | Callable && | callable | ) |
Creates a failure hook whose callable context is cloned and released by its creator.
| Callable | Copy-constructible callable accepting a shared const group handle and returning bool. |
| callable | Callback invoked with the partially parsed group. |
| ReadHook StormByte::Config::MakeReadHook | ( | Callable && | callable | ) |
Creates a read hook whose callable context is cloned and released by its creator.
| Callable | Copy-constructible callable accepting a shared mutable group handle. |
| callable | Callback invoked before/after text parsing. |
| std::ostream & StormByte::Config::operator<< | ( | std::ostream & | ostream, |
| const Config & | file ) |
Output configuration when ostream is on the left-hand side.
| ostream | Output stream. |
| file | Config to get data from. |
| std::string & StormByte::Config::operator<< | ( | std::string & | str, |
| const Config & | file ) |
Output configuration when string is on the left-hand side.
| str | Output string. |
| file | Config to get data from. |