description

Documentation

Index

• type Description
• type Format
  • func ParseFormat(s string) (Format, error)
  • func (g Format) MarshalText() ([]byte, error)
  • func (g Format) String() string
  • func (g *Format) UnmarshalText(data []byte) (err error)

Types

type Description

type Description struct {
	Text   string `json:"text"`
	Format Format `json:"format,omitempty" toml:",omitempty"`
}

Description - representation of a blurb of a book.

type Format

type Format uint8

Format - representation of formats of texts.

const (
	Undefined Format = iota
	Plain
	Markdown
	HTML
)

func ParseFormat

func ParseFormat(s string) (Format, error)

Convert a string to a Format, returns an error if the string is unknown.

func (Format) MarshalText

func (g Format) MarshalText() ([]byte, error)

func (Format) String

func (g Format) String() string

String allows Format to implement fmt.Stringer.

func (*Format) UnmarshalText

func (g *Format) UnmarshalText(data []byte) (err error)