termfs

Documentation

Overview

Package termfs provides a lightweight implementation of terminal device filesystem.

Index

• type CharMap
• type FS
  • func New(name string, r io.Reader, w io.Writer) *FS
  • func (fsys *FS) CharMap() CharMap
  • func (fsys *FS) Echo() bool
  • func (fsys *FS) LineMode() (enabled bool, maxLen int)
  • func (fsys *FS) Name() string
  • func (fsys *FS) OpenWithFinalizer(name string, flag int, perm fs.FileMode, closed func()) (fs.File, error)
  • func (fsys *FS) SetCharMap(cmap CharMap)
  • func (fsys *FS) SetEcho(on bool)
  • func (fsys *FS) SetLineMode(enable bool, maxLen int)
  • func (fsys *FS) Type() string
  • func (fsys *FS) Usage() (int, int, int64, int64)
• type LightFS
  • func NewLight(name string, r io.Reader, w io.Writer) *LightFS
  • func (fsys *LightFS) Name() string
  • func (fsys *LightFS) OpenWithFinalizer(name string, flag int, perm fs.FileMode, closed func()) (fs.File, error)
  • func (fsys *LightFS) Type() string
  • func (fsys *LightFS) Usage() (int, int, int64, int64)

Types

type CharMap

type CharMap uint8

const (
	InCRLF    CharMap = 1 << 0 // map input "\r" to "\n"
	OutLFCRLF CharMap = 1 << 3 // map output "\n" to "\r\n"

)

type FS

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

An FS provides a file system that represents a terminal device. As the embeded systems rarely require more than one terminal device (console) the FS is very simple and provides only one device file "." which can be opened, written and read concurenly by multiple goroutines.

func New

func New(name string, r io.Reader, w io.Writer) *FS

New returns a new terminal file system named name. The r and w correspond to the terminal input and output device.

func (*FS) CharMap

func (fsys *FS) CharMap() CharMap

func (*FS) Echo

func (fsys *FS) Echo() bool

Echo returns the echo configuration.

func (*FS) LineMode

func (fsys *FS) LineMode() (enabled bool, maxLen int)

LineMode returns the configuration of line mode.

func (*FS) Name

func (fsys *FS) Name() string

Name implements the rtos.FS Name method

func (*FS) OpenWithFinalizer

func (fsys *FS) OpenWithFinalizer(name string, flag int, perm fs.FileMode, closed func()) (fs.File, error)

OpenWithFinalizer implements the rtos.FS OpenWithFinalizer method. The name must be ".", the flag can be O_RDWR, O_RDONLY, O_WRONLY, the perm is ignored.

func (*FS) SetCharMap

func (fsys *FS) SetCharMap(cmap CharMap)

func (*FS) SetEcho

func (fsys *FS) SetEcho(on bool)

SetEcho enables/disables echoing of input data. Data are echoed by fs.File Read method. The echo is a confirmation that the reading goroutine is ready to consume data.

func (*FS) SetLineMode

func (fsys *FS) SetLineMode(enable bool, maxLen int)

SetLineMode allows to enable/disable the line mode and change the size of the internal line buffer. The default line buffer has zero size. Use maxLen > 0 to allocate a new one, maxLen == 0 to free it and maxLen < 0 to leave the line buffer unchanged.

In the line mode the terminal input is buffered until new-line character received. Small subset of ANSI terminal codes is supported to enable editing the line before passing it to the reading goroutine. There is also simple one line history implemented (use up, down arrows).

func (*FS) Type

func (fsys *FS) Type() string

Type implements the rtos.FS Type method

func (*FS) Usage

func (fsys *FS) Usage() (int, int, int64, int64)

Usage implements the rtos.FS Usage method

type LightFS

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

An LightFS provides a file system that represents a terminal device. It is a thin wrapper over provided io.Reader and io.Writer that allows use them concurently by multiple goroutines. Unlike FS it does not support CR/LF conversions, echo, line editing. If you need such futures use FS or configure your terminal emulator to handle them locally.

func NewLight

func NewLight(name string, r io.Reader, w io.Writer) *LightFS

NewLight returns a new terminal file system named name. The r and w correspond to the terminal input and output device.

func (*LightFS) Name

func (fsys *LightFS) Name() string

Name implements the rtos.FS Name method

func (*LightFS) OpenWithFinalizer

func (fsys *LightFS) OpenWithFinalizer(name string, flag int, perm fs.FileMode, closed func()) (fs.File, error)

OpenWithFinalizer implements the rtos.FS OpenWithFinalizer method. The name must be ".". The flag and perm are ignored.

func (*LightFS) Type

func (fsys *LightFS) Type() string

Type implements the rtos.FS Type method

func (*LightFS) Usage

func (fsys *LightFS) Usage() (int, int, int64, int64)

Usage implements the rtos.FS Usage method