readline

package module

Go to main page

Versions in this module

v0

v0.1.1

May 6, 2024

v0.1.1-rc2

May 5, 2024

v0.1.1-rc1

Apr 22, 2024

v0.1.0

Jan 14, 2024

Changes in this version

+ const CharCtrl_

type Config

+ Undo bool

v0.1.0-rc1

Jan 5, 2024

v0.0.6

Nov 7, 2023

Changes in this version

type Instance

+ func (i *Instance) ClearScreen()

v0.0.5

Jun 2, 2023

v0.0.4

Jun 2, 2023

Changes in this version

type Instance

+ func (i *Instance) DisableHistory()

+ func (i *Instance) EnableHistory()

+ func (i *Instance) GeneratePasswordConfig() *Config

+ func (i *Instance) ReadLine() (string, error)

+ func (i *Instance) ReadLineWithConfig(cfg *Config) (string, error)

+ func (i *Instance) ReadLineWithDefault(defaultValue string) (string, error)

+ func (i *Instance) SaveToHistory(content string) error

v0.0.3

Apr 18, 2023

Changes in this version

+ const CharEOT

+ const MetaDeleteKey

type Instance

+ func (i *Instance) GetConfig() *Config

+ func (i *Instance) SetDefault(defaultValue string)

v0.0.2

Mar 27, 2023

Changes in this version

+ const CharBackspace

+ const CharBackward

+ const CharBckSearch

+ const CharBell

+ const CharCtrlH

+ const CharCtrlJ

+ const CharCtrlL

+ const CharCtrlU

+ const CharCtrlW

+ const CharCtrlY

+ const CharCtrlZ

+ const CharDelete

+ const CharEnter

+ const CharEsc

+ const CharEscapeEx

+ const CharForward

+ const CharFwdSearch

+ const CharInterrupt

+ const CharKill

+ const CharLineEnd

+ const CharLineStart

+ const CharNext

+ const CharO

+ const CharPrev

+ const CharTab

+ const CharTranspose

+ const MetaBackspace

+ const MetaBackward

+ const MetaDelete

+ const MetaForward

+ const MetaShiftTab

+ const MetaTranspose

+ const S_DIR_BCK

+ const S_DIR_FWD

+ const S_STATE_FAILING

+ const S_STATE_FOUND

+ const T_DATA

+ const T_EOF

+ const T_ERAW

+ const T_ISTTY_REPORT

+ const T_RAW

+ const T_WIDTH

+ const T_WIDTH_REPORT

+ const VIM_INSERT

+ const VIM_NORMAL

+ const VIM_VISUAL

+ var ErrInterrupt = errors.New("Interrupt")

+ var NewEx = NewFromConfig

+ func DialRemote(n, addr string) error

+ func Do(p PrefixCompleterInterface, line []rune, pos int) (newLine [][]rune, offset int)

+ func ListenRemote(n, addr string, cfg *Config, h func(*Instance), ...) error

+ func Print(p PrefixCompleterInterface, prefix string, level int, buf *bytes.Buffer)

+ func RetSegment(segments [][]rune, cands [][]rune, idx int) ([][]rune, int)

+ func SplitSegment(line []rune, pos int) ([][]rune, int)

+ type AutoCompleter interface

+ Do func(line []rune, pos int) (newLine [][]rune, length int)

+ func SegmentFunc(f func([][]rune, int) [][]rune) AutoCompleter

+ type Config struct

+ AutoComplete AutoCompleter

+ DisableAutoSaveHistory bool

+ EOFPrompt string

+ EnableMask bool

+ ForceUseInteractive bool

+ FuncExitRaw func() error

+ FuncFilterInputRune func(rune) (rune, bool)

+ FuncGetSize func() (width int, height int)

+ FuncGetWidth func() int

+ FuncIsTerminal func() bool

+ FuncMakeRaw func() error

+ FuncOnWidthChanged func(func())

+ HistoryFile string

+ HistoryLimit int

+ HistorySearchFold bool

+ InterruptPrompt string

+ Listener Listener

+ MaskRune rune

+ Painter Painter

+ Prompt string

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ UniqueEditLine bool

+ VimMode bool

+ func (c *Config) Init() error

+ func (c *Config) SetListener(f func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool))

+ func (c Config) Clone() *Config

+ type DumpListener struct

+ func (d *DumpListener) OnChange(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)

+ type DynamicCompleteFunc func(string) []string

+ type DynamicPrefixCompleterInterface interface

+ GetDynamicNames func(line []rune) [][]rune

+ IsDynamic func() bool

+ type Instance struct

+ func HandleConn(cfg Config, conn net.Conn) (*Instance, error)

+ func New(prompt string) (*Instance, error)

+ func NewFromConfig(cfg *Config) (*Instance, error)

+ func (i *Instance) CaptureExitSignal()

+ func (i *Instance) Clean()

+ func (i *Instance) Close() error

+ func (i *Instance) GenPasswordConfig() *Config

+ func (i *Instance) HistoryDisable()

+ func (i *Instance) HistoryEnable()

+ func (i *Instance) IsVimMode() bool

+ func (i *Instance) ReadPassword(prompt string) ([]byte, error)

+ func (i *Instance) ReadPasswordWithConfig(cfg *Config) ([]byte, error)

+ func (i *Instance) ReadSlice() ([]byte, error)

+ func (i *Instance) Readline() (string, error)

+ func (i *Instance) ReadlineWithDefault(what string) (string, error)

+ func (i *Instance) Refresh()

+ func (i *Instance) ResetHistory()

+ func (i *Instance) SaveHistory(content string) error

+ func (i *Instance) SetConfig(cfg *Config) error

+ func (i *Instance) SetHistoryPath(p string)

+ func (i *Instance) SetMaskRune(r rune)

+ func (i *Instance) SetPrompt(s string)

+ func (i *Instance) SetVimMode(on bool)

+ func (i *Instance) Stderr() io.Writer

+ func (i *Instance) Stdout() io.Writer

+ func (i *Instance) Write(b []byte) (int, error)

+ func (i *Instance) WriteStdin(val []byte) (int, error)

+ type Listener interface

+ OnChange func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)

+ func FuncListener(f func(line []rune, pos int, key rune) (newLine []rune, newPos int, ok bool)) Listener

+ type Message struct

+ Data []byte

+ Type MsgType

+ func NewMessage(t MsgType, data []byte) *Message

+ func ReadMessage(r io.Reader) (*Message, error)

+ func (m *Message) WriteTo(w io.Writer) (int64, error)

+ type MsgType int16

+ type Operation struct

+ func NewOperation(t *Terminal, cfg *Config) *Operation

+ func (o *Operation) Clean()

+ func (o *Operation) Close()

+ func (o *Operation) GenPasswordConfig() *Config

+ func (o *Operation) GetConfig() *Config

+ func (o *Operation) IsNormalMode() bool

+ func (o *Operation) Password(prompt string) ([]byte, error)

+ func (o *Operation) PasswordWithConfig(cfg *Config) ([]byte, error)

+ func (o *Operation) Refresh()

+ func (o *Operation) ResetHistory()

+ func (o *Operation) Runes() ([]rune, error)

+ func (o *Operation) SaveHistory(content string) error

+ func (o *Operation) SetBuffer(what string)

+ func (o *Operation) SetHistoryPath(path string)

+ func (o *Operation) SetMaskRune(r rune)

+ func (o *Operation) SetPrompt(s string)

+ func (o *Operation) SetTitle(t string)

+ func (o *Operation) Slice() ([]byte, error)

+ func (o *Operation) Stderr() io.Writer

+ func (o *Operation) Stdout() io.Writer

+ func (o *Operation) String() (string, error)

+ func (op *Operation) SetConfig(cfg *Config) (*Config, error)

+ type Painter interface

+ Paint func(line []rune, pos int) []rune

+ type PrefixCompleter struct

+ Callback DynamicCompleteFunc

+ Children []PrefixCompleterInterface

+ Dynamic bool

+ Name []rune

+ func NewPrefixCompleter(pc ...PrefixCompleterInterface) *PrefixCompleter

+ func PcItem(name string, pc ...PrefixCompleterInterface) *PrefixCompleter

+ func PcItemDynamic(callback DynamicCompleteFunc, pc ...PrefixCompleterInterface) *PrefixCompleter

+ func (p *PrefixCompleter) Do(line []rune, pos int) (newLine [][]rune, offset int)

+ func (p *PrefixCompleter) GetChildren() []PrefixCompleterInterface

+ func (p *PrefixCompleter) GetDynamicNames(line []rune) [][]rune

+ func (p *PrefixCompleter) GetName() []rune

+ func (p *PrefixCompleter) IsDynamic() bool

+ func (p *PrefixCompleter) Print(prefix string, level int, buf *bytes.Buffer)

+ func (p *PrefixCompleter) SetChildren(children []PrefixCompleterInterface)

+ func (p *PrefixCompleter) Tree(prefix string) string

+ type PrefixCompleterInterface interface

+ Do func(line []rune, pos int) (newLine [][]rune, length int)

+ GetChildren func() []PrefixCompleterInterface

+ GetName func() []rune

+ Print func(prefix string, level int, buf *bytes.Buffer)

+ SetChildren func(children []PrefixCompleterInterface)

+ type RemoteCli struct

+ func NewRemoteCli(conn net.Conn) (*RemoteCli, error)

+ func (r *RemoteCli) Close()

+ func (r *RemoteCli) MarkIsTerminal(is bool)

+ func (r *RemoteCli) Serve() error

+ func (r *RemoteCli) ServeBy(source io.Reader) error

+ func (r *RemoteCli) Write(b []byte) (int, error)

+ type RemoteSvr struct

+ func NewRemoteSvr(conn net.Conn) (*RemoteSvr, error)

+ func (r *RemoteSvr) Close() error

+ func (r *RemoteSvr) EnterRawMode() error

+ func (r *RemoteSvr) ExitRawMode() error

+ func (r *RemoteSvr) GetWidth() int

+ func (r *RemoteSvr) GotIsTerminal(data []byte)

+ func (r *RemoteSvr) GotReportWidth(data []byte)

+ func (r *RemoteSvr) HandleConfig(cfg *Config)

+ func (r *RemoteSvr) IsTerminal() bool

+ func (r *RemoteSvr) Read(b []byte) (int, error)

+ func (r *RemoteSvr) Write(b []byte) (int, error)

+ type RuneBuffer struct

+ func NewRuneBuffer(w *Terminal, prompt string, cfg *Config) *RuneBuffer

+ func (r *RuneBuffer) BackEscapeWord()

+ func (r *RuneBuffer) Backspace()

+ func (r *RuneBuffer) Backup()

+ func (r *RuneBuffer) Clean()

+ func (r *RuneBuffer) CurrentWidth(x int) int

+ func (r *RuneBuffer) CursorLineCount() int

+ func (r *RuneBuffer) Delete() (success bool)

+ func (r *RuneBuffer) DeleteWord()

+ func (r *RuneBuffer) Erase()

+ func (r *RuneBuffer) IdxLine(width int) int

+ func (r *RuneBuffer) IsCursorInEnd() bool

+ func (r *RuneBuffer) Kill()

+ func (r *RuneBuffer) KillFront()

+ func (r *RuneBuffer) Len() int

+ func (r *RuneBuffer) LineCount() int

+ func (r *RuneBuffer) MoveBackward()

+ func (r *RuneBuffer) MoveForward()

+ func (r *RuneBuffer) MoveTo(ch rune, prevChar, reverse bool) (success bool)

+ func (r *RuneBuffer) MoveToEndWord()

+ func (r *RuneBuffer) MoveToLineEnd()

+ func (r *RuneBuffer) MoveToLineStart()

+ func (r *RuneBuffer) MoveToNextWord()

+ func (r *RuneBuffer) MoveToPrevWord() (success bool)

+ func (r *RuneBuffer) Pos() int

+ func (r *RuneBuffer) Print()

+ func (r *RuneBuffer) PromptLen() int

+ func (r *RuneBuffer) Refresh(f func())

+ func (r *RuneBuffer) Replace(ch rune)

+ func (r *RuneBuffer) Reset() []rune

+ func (r *RuneBuffer) Restore()

+ func (r *RuneBuffer) RuneSlice(i int) []rune

+ func (r *RuneBuffer) Runes() []rune

+ func (r *RuneBuffer) Set(buf []rune)

+ func (r *RuneBuffer) SetConfig(cfg *Config)

+ func (r *RuneBuffer) SetMask(m rune)

+ func (r *RuneBuffer) SetOffset(position cursorPosition)

+ func (r *RuneBuffer) SetPrompt(prompt string)

+ func (r *RuneBuffer) SetStyle(start, end int, style string)

+ func (r *RuneBuffer) SetWithIdx(idx int, buf []rune)

+ func (r *RuneBuffer) Transpose()

+ func (r *RuneBuffer) WriteRune(s rune)

+ func (r *RuneBuffer) WriteRunes(s []rune)

+ func (r *RuneBuffer) WriteString(s string)

+ func (r *RuneBuffer) Yank()

+ type SegmentComplete struct

+ func SegmentAutoComplete(completer SegmentCompleter) *SegmentComplete

+ func (c *SegmentComplete) Do(line []rune, pos int) (newLine [][]rune, offset int)

+ type SegmentCompleter interface

+ DoSegment func([][]rune, int) [][]rune

+ type TabCompleter struct

+ func (t *TabCompleter) Do([]rune, int) ([][]rune, int)

+ type Terminal struct

+ func NewTerminal(cfg *Config) (*Terminal, error)

+ func (t *Terminal) Bell()

+ func (t *Terminal) Close() error

+ func (t *Terminal) EnterRawMode() (err error)

+ func (t *Terminal) ExitRawMode() (err error)

+ func (t *Terminal) GetCursorPosition(deadline chan struct{}) (cursorPosition, error)

+ func (t *Terminal) GetRune(deadline chan struct{}) (rune, error)

+ func (t *Terminal) GetWidthHeight() (width, height int)

+ func (t *Terminal) OnSizeChange()

+ func (t *Terminal) SetConfig(c *Config) error

+ func (t *Terminal) SleepToResume()

+ func (t *Terminal) Write(b []byte) (int, error)

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