sessions

Documentation

Index

• Constants
• func EnsureDirectory(path string) error
• func GetFilename(dataDir string, path string) (string, error)
• func WriteAsciinema(filename string, events []Event) error
• type Event
• type Recorder
  • func NewRecorder(ctx context.Context, filename string, stream stream.Stream) (*Recorder, error)
  • func (s *Recorder) Events() []Event
  • func (s *Recorder) Read(p []byte) (n int, err error)
  • func (s *Recorder) Resize(size stream.Size) error
  • func (s *Recorder) Write(data []byte) (n int, err error)
• type SessionReader
  • func Open(filename string) (SessionReader, error)
• type SessionWriter
  • func Create(filename string) (SessionWriter, error)
• type Simulator
  • func NewSimulator() *Simulator
  • func (s *Simulator) Add(events ...interface{}) *Simulator
  • func (s *Simulator) AddTime(delta time.Duration, event interface{}) *Simulator
  • func (s *Simulator) Events() []Event
  • func (s *Simulator) Resize(size geom.Size) *Simulator
  • func (s *Simulator) ResizeTime(delta time.Duration, size geom.Size) *Simulator
  • func (s *Simulator) Term(i int, v ...interface{}) *Simulator
  • func (s *Simulator) TermTime(delta time.Duration, i int, v ...interface{}) *Simulator
  • func (s *Simulator) Write(data []byte) *Simulator
  • func (s *Simulator) WriteTime(delta time.Duration, data []byte) *Simulator

Constants

const (
	SESSION_FILE_VERSION = 1
)

Functions

func EnsureDirectory

func EnsureDirectory(path string) error

EnsureDirectory creates a directory if it does not exist and checks whether other users can read and write files in it.

func GetFilename

func GetFilename(dataDir string, path string) (string, error)

func WriteAsciinema

func WriteAsciinema(filename string, events []Event) error

Write `events` to the given file with path `filename` in the Asciicast v2 format. See https://docs.asciinema.org/manual/asciicast/v2/ for more information.

Types

type Event

type Event struct {
	Stamp   time.Time
	Message P.Message
}

type Recorder

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

func NewRecorder

func NewRecorder(ctx context.Context, filename string, stream stream.Stream) (*Recorder, error)

func (*Recorder) Events

func (s *Recorder) Events() []Event

func (*Recorder) Read

func (s *Recorder) Read(p []byte) (n int, err error)

func (*Recorder) Resize

func (s *Recorder) Resize(size stream.Size) error

func (*Recorder) Write

func (s *Recorder) Write(data []byte) (n int, err error)

type SessionReader

type SessionReader interface {
	Read() (Event, error)
}

func Open

func Open(filename string) (SessionReader, error)

type SessionWriter

type SessionWriter interface {
	Write(event Event) error
	Close() error
}

func Create

func Create(filename string) (SessionWriter, error)

type Simulator

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

Simulator is a convenient way of building recorded sessions programmatically, primarily for testing.

func NewSimulator

func NewSimulator() *Simulator

func (*Simulator) Add

func (s *Simulator) Add(events ...interface{}) *Simulator

func (*Simulator) AddTime

func (s *Simulator) AddTime(delta time.Duration, event interface{}) *Simulator

func (*Simulator) Events

func (s *Simulator) Events() []Event

func (*Simulator) Resize

func (s *Simulator) Resize(size geom.Size) *Simulator

func (*Simulator) ResizeTime

func (s *Simulator) ResizeTime(delta time.Duration, size geom.Size) *Simulator

func (*Simulator) Term

func (s *Simulator) Term(i int, v ...interface{}) *Simulator

Term invokes terminfo's Printf method and adds it to the session.

func (*Simulator) TermTime

func (s *Simulator) TermTime(delta time.Duration, i int, v ...interface{}) *Simulator

func (*Simulator) Write

func (s *Simulator) Write(data []byte) *Simulator

func (*Simulator) WriteTime

func (s *Simulator) WriteTime(delta time.Duration, data []byte) *Simulator