JavaScript is not enabled. It is needed for this website to work.
CFG 0.1.1.dev0 documentation
Index
Index
Table Of Contents
History
What,
another
new configuration format?
Review of other systems
Project Status
Reporting Problems
Features
High-Level Description
Elements
Example
Mappings
Keys and Values
Paths
Slices
Invalid paths
Lists
Scalar Values
Strings
Identifiers
Integers
Floating-point numbers
Complex numbers
Boolean values
Null
Includes
References
Special values
Special values – cross-platform
Native date/times
Environment Variables
Interpolated Strings
Special values – Python
Special values – Kotlin / Java
Special values – .NET
Special values – JavaScript
Expressions
Operators
Continuation lines
Interactive Playground for CFG
Application Programming Interfaces
The CFG API for Python
Backwards-Incompatible Changes
Format
Code
Modules
Installation
Getting Started with CFG in Python
Loading a configuration
Access elements with keys
Access elements with paths
Access to
datetime
objects
Access to other Python objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
A larger example - Django configuration
Classes
The
Location
class
The
ConfigError
class
The
Config
class
Config
The CFG API for Kotlin / Java
Installation
Exploration
Getting Started with CFG in Kotlin / Java
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other JVM objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
The CFG API for .NET
Installation
Exploration
Getting Started with CFG in C#
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other CLR objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Namespaces
Classes
The
Config
class
The CFG API for Rust
Usage
Exploration
Getting Started with CFG in Rust
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Types
Enums
Structs
The CFG API for Go
Installation
Exploration
Getting Started with CFG in Go
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Types
Functions
The CFG API for D
Installation
Exploration
Getting Started with CFG in D
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
The CFG API for JavaScript
Installation
Exploration
Getting Started with CFG in JavaScript
Loading a configuration
Usage in a browser
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
Config
Functions
makeStream()
The CFG API for Ruby
Installation
Exploration
Getting Started with CFG in Ruby
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other Ruby objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
The CFG API for Elixir
Installation
Exploration
Getting Started with CFG in Elixir
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other Elixir objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Modules
CFG.Location
CFG.RecognizerError
CFG.Config
The CFG API for Nim
Installation
Exploration
Getting Started with CFG in Nim
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Types
ValueKind (enum)
ConfigValue (object)
Location (object)
ConfigError (object)
Config (ref object)
The CFG API for Dart
Installation
Exploration
Getting Started with CFG in Dart
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Location
class
The
ConfigException
class
The
Config
class
A simplified grammar for CFG
A full grammar for CFG
Glossary
History
What,
another
new configuration format?
Review of other systems
Project Status
Reporting Problems
Features
High-Level Description
Elements
Example
Mappings
Keys and Values
Paths
Slices
Invalid paths
Lists
Scalar Values
Strings
Identifiers
Integers
Floating-point numbers
Complex numbers
Boolean values
Null
Includes
References
Special values
Special values – cross-platform
Native date/times
Environment Variables
Interpolated Strings
Special values – Python
Special values – Kotlin / Java
Special values – .NET
Special values – JavaScript
Expressions
Operators
Continuation lines
Interactive Playground for CFG
Application Programming Interfaces
The CFG API for Python
Backwards-Incompatible Changes
Format
Code
Modules
Installation
Getting Started with CFG in Python
Loading a configuration
Access elements with keys
Access elements with paths
Access to
datetime
objects
Access to other Python objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
A larger example - Django configuration
Classes
The
Location
class
The
ConfigError
class
The
Config
class
Config
The CFG API for Kotlin / Java
Installation
Exploration
Getting Started with CFG in Kotlin / Java
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other JVM objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
The CFG API for .NET
Installation
Exploration
Getting Started with CFG in C#
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other CLR objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Namespaces
Classes
The
Config
class
The CFG API for Rust
Usage
Exploration
Getting Started with CFG in Rust
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Types
Enums
Structs
The CFG API for Go
Installation
Exploration
Getting Started with CFG in Go
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Types
Functions
The CFG API for D
Installation
Exploration
Getting Started with CFG in D
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
The CFG API for JavaScript
Installation
Exploration
Getting Started with CFG in JavaScript
Loading a configuration
Usage in a browser
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
Config
Functions
makeStream()
The CFG API for Ruby
Installation
Exploration
Getting Started with CFG in Ruby
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other Ruby objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Config
class
The CFG API for Elixir
Installation
Exploration
Getting Started with CFG in Elixir
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to other Elixir objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Modules
CFG.Location
CFG.RecognizerError
CFG.Config
The CFG API for Nim
Installation
Exploration
Getting Started with CFG in Nim
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Types
ValueKind (enum)
ConfigValue (object)
Location (object)
ConfigError (object)
Config (ref object)
The CFG API for Dart
Installation
Exploration
Getting Started with CFG in Dart
Loading a configuration
Access elements with keys
Access elements with paths
Access to date/time objects
Access to environment variables
Access to computed values
Including one configuration inside another
Avoiding unnecessary repetition
Classes
The
Location
class
The
ConfigException
class
The
Config
class
A simplified grammar for CFG
A full grammar for CFG
Glossary
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
Symbols
(config.*Config) AsDict (Golang function)
(config.*Config) Get (Golang function)
(config.*Config) GetWithDefault (Golang function)
(config.*Config) Load (Golang function)
(config.*Config) LoadFile (Golang function)
_
__init__
Config class
A
Abstract Syntax Tree (AST)
add_include (Rust function)
as_dict() (Config method)
as_mapping (Rust function)
AtomExpected (Rust member)
B
backtick-string
BadFilePath (Rust member)
Base (Rust member)
Bool (Rust member)
C
CircularReferenceError (Rust member)
close() (Config method)
column: i32 (Rust member)
Complex (Rust member)
Config
C# class
Config class
D class
Dart class
Elixir module
JavaScript class
Kotlin class
Nim type
Python class
Ruby class
Config (built-in class)
,
[1]
config (package)
Config (Rust member)
(Rust struct)
Config() (class)
config.Any (Golang type)
Config.cached: bool = false (Config attribute)
config.Config (Golang type)
Config.context: object (Config attribute)
config.FromFile (Golang function)
Config.includePath: string[] (Config attribute)
config.Mapping (Golang type)
config.NewConfig (Golang function)
Config.noDuplicates: bool = true (Config attribute)
Config.path: string = null (Config attribute)
config.Sequence (Golang type)
Config.strictConversions: bool = true (Config attribute)
ConfigError
Nim type
ConfigError (Rust enum)
ConfigValue
Nim object
container
ContainerExpected (Rust member)
contains_key (Rust function)
context (Config attribute)
,
[1]
ConversionError (Rust member)
D
Date (Rust member)
DateTime (Rust member)
DuplicateKey (Rust member)
E
EvaluationFailed (Rust member)
F
FileNotFound (Rust member)
FileReadFailed (Rust member)
Float (Rust member)
from_file (Rust function)
G
get (Rust function)
get() (Config method)
I
Identifier (Rust member)
include_path (Config attribute)
includePath (Config attribute)
IndexOutOfRange (Rust member)
Integer (Rust member)
InvalidCharacter (Rust member)
InvalidEscapeSequence (Rust member)
InvalidNumber (Rust member)
InvalidPath (Rust member)
InvalidPathOperand (Rust member)
InvalidString (Rust member)
Io (Rust member)
K
KeyExpected (Rust member)
KeyValueSeparatorExpected (Rust member)
L
line: i32 (Rust member)
list
List (Rust member)
list body
load (Rust function)
load() (Config method)
load_from_file (Rust function)
Location
Elixir module
Nim type
Location (Rust struct)
M
makeStream() (built-in function)
mapping
Mapping (Rust member)
mapping body
MappingExpected (Rust member)
N
new (Rust function)
no_duplicates (Config attribute)
no_duplicates: bool (Rust member)
NoContext (Rust member)
NotLoaded (Rust member)
NotPresent (Rust member)
Null (Rust member)
numbers
complex numbers
floating-point numbers
integers
P
path
(Config attribute)
,
[1]
R
RecognizerError
Elixir module
RecognizerError (Rust enum)
S
ScalarValue (Rust enum)
set_context (Rust function)
slice
strict_conversions (Config attribute)
String (Rust member)
StringExpected (Rust member)
SyntaxError (Rust member)
T
TrailingText (Rust member)
U
UnexpectedCharacter (Rust member)
UnexpectedListSize (Rust member)
UnexpectedToken (Rust member)
UnknownVariable (Rust member)
UnterminatedString (Rust member)
V
value
Value (Rust enum)
ValueExpected (Rust member)
ValueKind
Nim enum
values
Booleans
complex numbers
expressions
floating-point numbers
identifiers
includes
integers
mappings
null
references
scalar values
sequences (lists)
special values
strings