json

Documentation

Index

• Variables
• type Encoder
  • func NewEncoder(out io.Writer) *Encoder
  • func (e *Encoder) Encode(bookmarks []bookmark.Bookmark) error
  • func (e *Encoder) Filename() string
  • func (e *Encoder) String() string

Variables

var EncoderName = encoding.ToEncoder(constants.JSONFormat)

EncoderName is name of the encoder in current package, i.e., JSON. JSONFormat constant is parsed as EncoderName type here.

Types

type Encoder

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

Encoder is the manager for JSON encoder

func NewEncoder

func NewEncoder(out io.Writer) *Encoder

NewEncoder initializes new Encoder

func (*Encoder) Encode

func (e *Encoder) Encode(bookmarks []bookmark.Bookmark) error

Encode encodes the input bookmarks in JSON format to already set output stream

func (*Encoder) Filename

func (e *Encoder) Filename() string

Filename returns the file name string derived from output stream, iff the output stream is of pkg/files.File type.

func (*Encoder) String

func (e *Encoder) String() string

String returns the encoder name derived in EncoderName. This returns the same value as EncoderName, but using the receiver.