sessions

README

sessions

Package sessions contains a data type for recorded terminal sessions and a range of utilities for (de)serializing, searching through, and exporting them.

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 EventHandler
• type EventStream
  • func NewEventStream(stream stream.Stream, handler EventHandler) *EventStream
  • func (s *EventStream) Kill()
  • func (s *EventStream) Read(p []byte) (n int, err error)
  • func (s *EventStream) Resize(size stream.Size) error
  • func (s *EventStream) Write(data []byte) (n int, err error)
• type FileRecorder
  • func NewFileRecorder(ctx context.Context, filename string) (*FileRecorder, error)
  • func (f *FileRecorder) Flush() error
  • func (f *FileRecorder) Process(event Event) error
• type MemoryRecorder
  • func NewMemoryRecorder() *MemoryRecorder
  • func (r *MemoryRecorder) Events() []Event
  • func (r *MemoryRecorder) Process(event Event) error
• type MultiplexHandler
  • func NewMultiplexHandler(handlers ...EventHandler) *MultiplexHandler
  • func (m *MultiplexHandler) Process(event Event) 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) Defaults() *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) Terminal() emu.Terminal
  • func (s *Simulator) Write(data []byte) *Simulator
  • func (s *Simulator) WriteBorg(path string) error
  • func (s *Simulator) WriteTime(delta time.Duration, data []byte) *Simulator

Constants

const (
	// GZIP_BUFFER_SIZE is the number of bytes to write before flushing
	// to disk. Terminal sessions are surprisingly small, so flushing
	// every 128k feels safe, but we may need to play with this.
	GZIP_BUFFER_SIZE = 128 * 1024
)

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 EventHandler

type EventHandler interface {
	Process(event Event) error
}

An EventHandler handles a stream of terminal events.

type EventStream

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

An EventStream is a proxy for a Stream that turns everything that happens on that Stream into Event structs and passes them to the provided handler.

func NewEventStream

func NewEventStream(stream stream.Stream, handler EventHandler) *EventStream

func (*EventStream) Kill

func (s *EventStream) Kill()

func (*EventStream) Read

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

func (*EventStream) Resize

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

func (*EventStream) Write

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

type FileRecorder

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

A FileRecorder writes incoming events to a file.

func NewFileRecorder

func NewFileRecorder(ctx context.Context, filename string) (*FileRecorder, error)

func (*FileRecorder) Flush

func (f *FileRecorder) Flush() error

func (*FileRecorder) Process

func (f *FileRecorder) Process(event Event) error

type MemoryRecorder

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

A MemoryRecorder stores Events in memory.

func NewMemoryRecorder

func NewMemoryRecorder() *MemoryRecorder

func (*MemoryRecorder) Events

func (r *MemoryRecorder) Events() []Event

func (*MemoryRecorder) Process

func (r *MemoryRecorder) Process(event Event) error

type MultiplexHandler

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

A MultiplexHandler chains multiple EventHandlers together in sequence, but returns a single EventHandler.

func NewMultiplexHandler

func NewMultiplexHandler(handlers ...EventHandler) *MultiplexHandler

func (*MultiplexHandler) Process

func (m *MultiplexHandler) Process(event Event) 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
	Flush() 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) Defaults

func (s *Simulator) Defaults() *Simulator

Defaults adds events to reset the terminal's size to DEFAULT_SIZE and changes it to LineFeedMode.

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) Terminal

func (s *Simulator) Terminal() emu.Terminal

Terminal processes all of the events in the simulator in a new terminal and returns it.

func (*Simulator) Write

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

func (*Simulator) WriteBorg

func (s *Simulator) WriteBorg(path string) error

WriteBorg writes the simulator's events to a borg file at the given path.

func (*Simulator) WriteTime

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