textbundle

README

EXPERIMENTAL TextBundle library for Go

This is a little Go library for working with TextBundle resources.

Documentation

Index

• type Asset
• type Metadata
• type Reader
  • func OpenReader(path string) (*Reader, error)
• type Writer
  • func NewWriter(out io.Writer) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) CreateAsset(name string) (io.Writer, error)
  • func (w *Writer) Flush() error
  • func (w *Writer) SetText(typ string, content string) error

Types

type Asset

type Asset struct {
	Name string
	File *zip.File
}

Asset is a light wrapper around zip.File that trims the filename.

type Metadata

type Metadata struct {
	Version           int    `json:"version"`
	Type              string `json:"type,omitempty"`
	Transient         bool   `json:"transient,omitempty"`
	CreatorURL        string `json:"creatorURL,omitempty"`
	CreatorIdentifier string `json:"creatorIdentifier,omitempty"`
	SourceURL         string `json:"sourceURL,omitempty"`
}

type Reader

type Reader struct {
	Metadata Metadata
	Text     []byte
	Assets   []Asset
}

Reader allows access the seperate Assets of a TextBundle, its content, and the associated metadata.

func OpenReader

func OpenReader(path string) (*Reader, error)

OpenReader creates a new Reader from the given file path.

type Writer

type Writer struct {
	Metadata Metadata
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(out io.Writer) *Writer

NewWriter creates a new writer which should be persisted to the out.

func (*Writer) Close

func (w *Writer) Close() error

Close finalizes the bundles metadata and closes the underlying writer.

func (*Writer) CreateAsset

func (w *Writer) CreateAsset(name string) (io.Writer, error)

CreateAsset creates a new asset file with the given name.

func (*Writer) Flush

func (w *Writer) Flush() error

Flush flushes the underlying writer.

func (*Writer) SetText

func (w *Writer) SetText(typ string, content string) error

SetText writes Content.textbundle/text.$typ.