properties

Documentation

Overview

Package properties is used to read or write or modify the properties document.

Index

• func Save(doc *Document, writer io.Writer) error
• type Document
  • func New() *Document
  • func (p *Document) Accept(f func(typo byte, value string, key string) bool)
  • func (p *Document) Get(key string) (value string, exist bool)
  • func (p *Document) Set(key string, value string)

Functions

func Save

func Save(doc *Document, writer io.Writer) error

Save is used to save the doc to file or stream.

Types

type Document

type Document struct {
	// contains filtered or unexported fields
}

Document The properties document in memory.

func New

func New() *Document

New is used to create a new and empty properties document.

It's used to generate a new document.

func (*Document) Accept

func (p *Document) Accept(f func(typo byte, value string, key string) bool)

Accept Traverse every element of the document, include comment.

The typo parameter special the element type. If typo is '#' or '!' means current element is a comment. If typo is ' ' means current element is a empty or a space line. If typo is '=' or ':' means current element is a key-value pair. The traverse will be terminated if f return false.

func (*Document) Get

func (p *Document) Get(key string) (value string, exist bool)

Get Retrieve the value from Document.

If the item is not exist, the exist is false.

func (*Document) Set

func (p *Document) Set(key string, value string)

Set Update the value of the item of the key.

Create a new item if the item of the key is not exist.