asciinema

Documentation

Index

• type Config
• type Env
• type Header
• type Option
  • func WithEnvShell(shell string) Option
  • func WithEnvTerm(term string) Option
  • func WithHeight(height int) Option
  • func WithTimestamp(timestamp time.Time) Option
  • func WithTitle(title string) Option
  • func WithWidth(width int) Option
• type Writer
  • func NewWriter(w io.Writer, opts ...Option) *Writer
  • func (w *Writer) WriteHeader() error
  • func (w *Writer) WriteRow(p []byte) error
  • func (w *Writer) WriteStdout(ts float64, data []byte) error

Types

type Config

type Config struct {
	Title     string
	EnvShell  string
	EnvTerm   string
	Width     int
	Height    int
	Timestamp time.Time
}

type Env

type Env struct {
	Shell string `json:"SHELL"`
	Term  string `json:"TERM"`
}

type Header

type Header struct {
	Version   int    `json:"version"`
	Width     int    `json:"width"`
	Height    int    `json:"height"`
	Timestamp int64  `json:"timestamp"`
	Title     string `json:"title"`
	Env       Env    `json:"env"`
}

type Option

type Option func(options *Config)

func WithEnvShell

func WithEnvShell(shell string) Option

func WithEnvTerm

func WithEnvTerm(term string) Option

func WithHeight

func WithHeight(height int) Option

func WithTimestamp

func WithTimestamp(timestamp time.Time) Option

func WithTitle

func WithTitle(title string) Option

func WithWidth

func WithWidth(width int) Option

type Writer

type Writer struct {
	Config
	TimestampNano int64
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(w io.Writer, opts ...Option) *Writer

func (*Writer) WriteHeader

func (w *Writer) WriteHeader() error

func (*Writer) WriteRow

func (w *Writer) WriteRow(p []byte) error

func (*Writer) WriteStdout

func (w *Writer) WriteStdout(ts float64, data []byte) error