core/encoding/ini package | Odin Programming Language

Reader and writer for a variant of the `.ini` file format with `key = value` entries in `[sections]`.

Collection Info

View Source

Collection: core
Path: encoding/ini
Entries: 13

Constants 1

Types 3

Procedures 9

delete_map iterate iterator_from_string load_map_from_path load_map_from_string save_map_to_string write_map write_pair write_section

Procedure Groups 0

Variables 0

Source Files

Constants

DEFAULT_OPTIONS #

Source

DEFAULT_OPTIONS :: Options{comment = ";", key_lower_case = false}

Types

Iterator #

Source

Iterator :: Iterator

Map #

Source

Map :: distinct Map

Options #

Source

Options :: Options

Procedures

delete_map #

Source

delete_map :: proc(m: Map) {…}

iterate #

Source

iterate :: proc(it: ^Iterator) -> (key, value: string, ok: bool) {…}

Returns the raw `key` and `value`. `ok` will be false if no more key=value pairs cannot be found. They key and value may be quoted, which may require the use of `strconv.unquote_string`.

iterator_from_string #

Source

iterator_from_string :: proc(src: string, options: Options = DEFAULT_OPTIONS) -> Iterator {…}

load_map_from_path #

Source

load_map_from_path :: proc(path: string, allocator: Allocator, options: Options = DEFAULT_OPTIONS) -> (m: Map, err: Allocator_Error, ok: bool) {…}

load_map_from_string #

Source

load_map_from_string :: proc(src: string, allocator: Allocator, options: Options = DEFAULT_OPTIONS) -> (m: Map, err: Allocator_Error) {…}

save_map_to_string #

Source

save_map_to_string :: proc(m: Map, allocator: Allocator) -> (data: string) {…}

write_map #

Source

write_map :: proc(w: Stream, m: Map) -> (n: int, err: Error) {…}

write_pair #

Source

write_pair :: proc(w: Stream, key: string, value: $T, n_written: ^int = nil) -> (n: int, err: Error) {…}

write_section #

Source

write_section :: proc(w: Stream, name: string, n_written: ^int = nil) -> (n: int, err: Error) {…}