Keyboard

Documentation

Index

• type Keyboard
  • func NewKeyboard() *Keyboard
  • func (k *Keyboard) Close() error
  • func (k *Keyboard) GetErrorChannel() <-chan error
  • func (k *Keyboard) GetKeyChannel() <-chan keyboard.Key
  • func (k *Keyboard) Start() error
  • func (k *Keyboard) Wait()

Types

type Keyboard

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

Keyboard handles keyboard input using the eiannone/keyboard package.

func NewKeyboard

func NewKeyboard() *Keyboard

NewKeyboard creates a new Keyboard.

Returns:

• *Keyboard: The new Keyboard.

func (*Keyboard) Close

func (k *Keyboard) Close() error

Close closes the Keyboard.

Returns:

• error: An error if the Keyboard could not be closed.

func (*Keyboard) GetErrorChannel

func (k *Keyboard) GetErrorChannel() <-chan error

GetErrorChannel returns the error channel for the Keyboard.

Returns:

• <-chan error: The error channel.

func (*Keyboard) GetKeyChannel

func (k *Keyboard) GetKeyChannel() <-chan keyboard.Key

GetKeyChannel returns the key channel for the Keyboard.

Returns:

• <-chan keyboard.Key: The key channel.

func (*Keyboard) Start

func (k *Keyboard) Start() error

Start starts the Keyboard.

Returns:

• error: An error if the Keyboard could not be started.

func (*Keyboard) Wait

func (k *Keyboard) Wait()

Wait waits for the Keyboard to finish. It may cause a deadlock if the Keyboard is not closed.