basic

package

v0.2.5 Latest Latest Go to latest Published: Sep 5, 2023 License: MIT Imports: 8 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package basic provides a basic representation of dosini-style documents

View Source

const WriteNewLine = "\n"

WriteNewLine is the new line representation used by [doc.WriteTo]

This section is empty.

This section is empty.

type Document struct {
	Global []Field

	Sections []Section
}

Document represents an INI-style document

func Decode(r io.Reader) (*Document, error)

Decode attempts to decode an INI-style from an io.Reader array into a Document

func DecodeBytes(b []byte) (*Document, error)

DecodeBytes attempts to decode an INI-style bytes array into a Document

func DecodeString(s string) (*Document, error)

DecodeString attempts to decode an INI-style string into a Document

func (doc *Document) AsBuffer(nl string) *bytes.Buffer

AsBuffer returns a INI representation of the document on a memory buffer

func (doc *Document) String() string

String generates a string output for "%s"

func (doc *Document) WriteTo(w io.Writer) (int64, error)

WriteTo writes a INI representation of the document onto the provided writer.

type Field struct {
	Key   string
	Value string
}

Field represents a key = value entry in an INI-style document

func (field Field) String() string

String generates a string output for "%s"

type Section struct {
	Key     string
	ID      string
	EmptyID bool

	Fields []Field
}

Section represents an INI-style section with optional GIT-style IDs

func (sec *Section) String() string

String generates a string output for "%s"