ui

package

v0.0.0-...-aadac20 Latest Latest Go to latest Published: Feb 17, 2024 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/makyo/stimmtausch

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ui provides the user interface for Stimmtausch.

Index ¶

func New(c *client.Client) *tui
type History
- func NewHistory(max int, allowFragments bool) *History
type HistoryLine

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(c *client.Client) *tui

New instantiates a new Stimmtausch UI.

Types ¶

type History ¶

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

History represents a rolling buffer of lines used for input and output.

func NewHistory ¶

func NewHistory(max int, allowFragments bool) *History

NewHistory returns a new history buffer.

func (*History) AddPostWriteHook ¶

func (h *History) AddPostWriteHook(f func(*HistoryLine) error)

AddPostWriteHook accepts a function to be run whenever a write to the buffer succeeds.

func (*History) Back ¶

func (h *History) Back() *HistoryLine

Back moves the cursor back in time one line and returns the current line's content.

func (*History) Close ¶

func (h *History) Close() error

Close does nothing, and does it splendidly. Fulfills io.Closer

func (*History) Current ¶

func (h *History) Current() *HistoryLine

Current returns the current line in the buffer.

func (*History) Forward ¶

func (h *History) Forward() *HistoryLine

Forward moves the cursor forward in time one line and returns the current line's content.

func (*History) Last ¶

func (h *History) Last() *HistoryLine

Last moves the cursor to the last line.

func (*History) Size ¶

func (h *History) Size() int

func (*History) String ¶

func (h *History) String() string

String outputs the entire buffer as it stands.

func (*History) Write ¶

func (h *History) Write(line []byte) (int, error)

Write accepts a byte array and appends it to the buffer. It then executes every post-write hook. It returns the number of bytes written and any errors that occured. Fulfills io.Writer

type HistoryLine ¶

type HistoryLine struct {
	Timestamp time.Time
	Text      string
}

HistoryLine represents a timestamped line of text.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL