go_input_history

package module

v1.0.0 Latest Latest Go to latest Published: Feb 4, 2022 License: MIT Imports: 1 Imported by: 0

Details

Package input history contains structs and methods to aid in developing cli ui's with input history

This section is empty.

This section is empty.

This section is empty.

type History struct {
	Max   int
	Data  []string
	Index int
	// contains filtered or unexported fields
}

History struct to hold the history of the user input

func New(max int) *History

New history struct

func (h *History) Add(line string)

Add line to history

func (h *History) Get(index int) string

Get history at index

func (h *History) HasLine(line string) bool

HasLine will return true if the history buffer contains the given string

func (h *History) IsEmpty() bool

IsEmpty return true if the history data array is empty

func (h *History) Next() string

Next returns the history line after the current index

func (h *History) Prev() string

Prev returns the previous history line from the current index

func (h *History) SetIndexToNew()

SetIndexToNew sets the index to the new elements index