Index

Modules: iniplus, iniplus/objects, iniplus/private/utils, iniplus/reader, iniplus/retrieve, iniplus/writer.

API symbols

`!=`:

• objects: proc `!=`(a, b: ConfigValue): bool
• objects: proc `!=`(a: ConfigValue; b: seq[ConfigValue]): bool
• objects: proc `!=`(b: seq[ConfigValue]; a: ConfigValue): bool

`$`:

• objects: proc `$`(k: ConfigValueKind): string
• writer: proc `$`(table: ConfigTable): string
• writer: proc `$`(value: ConfigValue): string

`==`:

• objects: proc `==`(a, b: ConfigValue): bool
• objects: proc `==`(a: ConfigValue; b: seq[ConfigValue]): bool
• objects: proc `==`(b: seq[ConfigValue]; a: ConfigValue): bool

`@=`:

• objects: proc `@=`[T](val: T): ConfigValue

Array:

• utils: State.Array

Colon:

• utils: TokenKind.Colon

Comma:

• utils: TokenKind.Comma

ConfigTable:

• objects: type ConfigTable

ConfigValue:

• objects: object ConfigValue

ConfigValueKind:

• objects: enum ConfigValueKind

conv:

• utils: proc conv(v: seq[string]; table = false): ConfigValue
• utils: proc conv(v: string): ConfigValue

createTable:

• writer: proc createTable(data: openArray[(string, Table[string, ConfigValue])]): ConfigTable

CTable:

• utils: State.CTable

CurlyClose:

• utils: TokenKind.CurlyClose

CurlyOpen:

• utils: TokenKind.CurlyOpen

CVArray:

• objects: ConfigValueKind.CVArray

CVBool:

• objects: ConfigValueKind.CVBool

CVInt:

• objects: ConfigValueKind.CVInt

CVNone:

• objects: ConfigValueKind.CVNone

CVString:

• objects: ConfigValueKind.CVString

CVTable:

• objects: ConfigValueKind.CVTable

detectChildKind:

• utils: proc detectChildKind(c: ConfigValue): ConfigValueKind

dump:

• writer: proc dump(table: ConfigTable): string

EqualSign:

• utils: TokenKind.EqualSign

exists:

• retrieve: proc exists(table: ConfigTable; section, key: string): bool

getArray:

• retrieve: proc getArray(table: ConfigTable; section, key: string): seq[ConfigValue]

getBool:

• retrieve: proc getBool(table: ConfigTable; section, key: string): bool

getBoolArray:

• retrieve: proc getBoolArray(table: ConfigTable; section, key: string): seq[bool]

getBoolArrayOrDefault:

• retrieve: proc getBoolArrayOrDefault(table: ConfigTable; section, key: string; default: seq[bool]): seq[bool]

getBoolOrDefault:

• retrieve: proc getBoolOrDefault(table: ConfigTable; section, key: string; default: bool): bool

getInt:

• retrieve: proc getInt(table: ConfigTable; section, key: string): int

getIntArray:

• retrieve: proc getIntArray(table: ConfigTable; section, key: string): seq[int]

getIntArrayOrDefault:

• retrieve: proc getIntArrayOrDefault(table: ConfigTable; section, key: string; default: seq[int]): seq[ int]

getIntOrDefault:

• retrieve: proc getIntOrDefault(table: ConfigTable; section, key: string; default: int): int

getString:

• retrieve: proc getString(table: ConfigTable; section, key: string): string

getStringArray:

• retrieve: proc getStringArray(table: ConfigTable; section, key: string): seq[string]

getStringArrayOrDefault:

• retrieve: proc getStringArrayOrDefault(table: ConfigTable; section, key: string; default: seq[string]): seq[string]

getStringOrDefault:

• retrieve: proc getStringOrDefault(table: ConfigTable; section, key, default: string): string

getTable:

• retrieve: proc getTable(table: ConfigTable; section, key: string): OrderedTable[string, ConfigValue]

getValue:

• retrieve: proc getValue(table: ConfigTable; section, key: string): ConfigValue

isBoolean:

• utils: proc isBoolean(raw: string): bool

isOnlyDigits:

• utils: proc isOnlyDigits(raw: string): bool

Literal:

• utils: TokenKind.Literal

newConfigTable:

• writer: proc newConfigTable(): ConfigTable

newCValue:

• objects: proc newCValue(value: bool): ConfigValue
• objects: proc newCValue(value: int): ConfigValue
• objects: proc newCValue[T](val: openArray[T]): ConfigValue
• objects: proc newCValue(value: seq[ConfigValue]): ConfigValue
• objects: proc newCValue(value: string): ConfigValue
• objects: proc newCValue(value: varargs[ConfigValue]): ConfigValue

Newline:

• utils: TokenKind.Newline

None:

• utils: State.None

parseFile:

• reader: proc parseFile(filename: string): ConfigTable

parseString:

• reader: proc parseString(input: string): ConfigTable

Quoted:

• utils: TokenKind.Quoted

Section:

• utils: State.Section

setKey:

• writer: proc setKey(table: var ConfigTable; section, key: string; value: ConfigValue)
• writer: proc setKey[T](table: var ConfigTable; section, key: string; value: T)

setKeys:

• writer: proc setKeys(table: var ConfigTable; data: openArray[(string, Table[string, ConfigValue])])

SquareClose:

• utils: TokenKind.SquareClose

SquareOpen:

• utils: TokenKind.SquareOpen

State:

• utils: enum State

Token:

• utils: object Token

TokenKind:

• utils: enum TokenKind

toString:

• writer: proc toString(table: ConfigTable): string
• writer: proc toString(val: ConfigValue): string

trimString:

• utils: proc trimString(raw: string): string

Val:

• utils: State.Val