buffer

Documentation

Index

• Variables
• func IsValidBufferState(state string) bool
• func ValidBufferStatesStr() string
• type Buffer
  • func (b Buffer) AllowsMultipleInit() bool
  • func (b Buffer) BufferName() string
  • func (b Buffer) String() string
• type BufferInterface

Variables

var ValidBufferStates = map[string]bool{

	"empty": true,
	"full":  true,

	"busy":  true,
	"error": true,
}

ValidBufferStates is a list of the valid buffer states to use with the _status chunk TODO: needs review and correction See: https://github.com/asmaloney/gactar/discussions/221

Functions

func IsValidBufferState

func IsValidBufferState(state string) bool

IsValidBufferState checks if 'state' is a valid buffer state.

func ValidBufferStatesStr

func ValidBufferStatesStr() string

ValidBufferStatesStr returns a list of (sorted) valid buffer states. Used for error output.

Types

type Buffer

type Buffer struct {
	Name string

	MultipleInit bool
}

func (Buffer) AllowsMultipleInit

func (b Buffer) AllowsMultipleInit() bool

func (Buffer) BufferName

func (b Buffer) BufferName() string

func (Buffer) String

func (b Buffer) String() string

type BufferInterface

type BufferInterface interface {
	BufferName() string
	AllowsMultipleInit() bool
}