basic

Documentation

Overview

Package basic provides a basic representation of dosini-style documents

Index

• Constants
• type Document
  • func Decode(r io.Reader) (*Document, error)
  • func DecodeBytes(b []byte) (*Document, error)
  • func DecodeString(s string) (*Document, error)
  • func (doc *Document) AsBuffer(nl string) *bytes.Buffer
  • func (doc *Document) String() string
  • func (doc *Document) WriteTo(w io.Writer) (int64, error)
• type Field
• type Section

Constants

const WriteNewLine = "\n"

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

Types

type Document

type Document struct {
	Global []Field

	Sections []Section
}

Document represents an INI-style document

func Decode

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

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

func DecodeBytes

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

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

func DecodeString

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

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

func (*Document) AsBuffer

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

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

func (*Document) String

func (doc *Document) String() string

GoString generates a string output for "%s"

func (*Document) WriteTo

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

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

type Field

type Field struct {
	Key   string
	Value string
}

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

type Section

type Section struct {
	Key     string
	ID      string
	EmptyID bool

	Fields []Field
}

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