package editor

Import Path
	github.com/reeflective/readline/internal/editor (on go.dev)

Dependency Relation
	imports 16 packages, and imported by one package

Involved Source Files

	    buffers.go
	    editor.go
	    editor_unix.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Buffers (struct)
		Buffers is a list of registers in which to put yanked/cut contents.
		These buffers technically are Vim registers with full functionality.

		Methods (total 11)
			(*Buffers) Active() []rune
				Active returns the contents of the active buffer/register (or the kill
				buffer if no active register is active), and resets the active register.

			(*Buffers) Complete() completion.Values
				Complete returns the contents of all buffers as a structured list of completions.

			(*Buffers) EditBuffer(buf []rune, filename, filetype string, emacs bool) ([]rune, error)
				EditBuffer starts the system editor and opens the given buffer in it.
				If the filename is specified, the file will be created in the system
				temp directory under this name.
				If the filetype is not empty and if the system editor supports it, the
				file will be opened with the specified filetype passed to the editor.

			(*Buffers) Get(register rune) []rune
				Get returns the contents of a given register.
				If the rune is nil (rune(0)), it returns the value of the kill buffer (the " Vim register).
				If the rune is an alphanumeric comprised in the valid register IDs, their content is returned.
				If the register name is invalid, the function returns an empty rune slice.

			(*Buffers) GetKill() []rune
				GetKill returns the contents of the kill buffer.

			(*Buffers) IsSelected() (name string, selected bool)
				IsSelected returns the name of the selected register, and
				true if one is indeed selected, or the default one and false.

			(*Buffers) Pop() []rune
				Pop rotates the kill ring and returns the new top.

			(*Buffers) Reset()
				Reset forgets any active/pending buffer/register, but does not delete its contents.

			(*Buffers) SetActive(register rune)
				SetActive sets the currently active register/buffer.
				Valid values are letters (lower/upper), digits (1-9),
				or read-only buffers ( . % : ).

			(*Buffers) Write(content ...rune)
				Write writes a slice to the currently active buffer, and/or to the kill one.
				After the operation, the buffers are reset, eg. none is considered active.

			(*Buffers) WriteTo(register rune, content ...rune)
				WriteTo writes a slice directly to a target register.
				If the register name is invalid, nothing is written anywhere.

		As Outputs Of (at least one exported)
			func NewBuffers() *Buffers


Package-Level Functions (only one)

	 func NewBuffers() *Buffers
		NewBuffers is a required constructor to set up all the buffers/registers
		for the shell, because it contains maps that must be correctly initialized.


Package-Level Variables (total 7)

	  var ErrCreate error
		ErrCreate indicates that we failed to create the temp buffer file.

	  var ErrNoTempDirectory error
		ErrNoTempDirectory indicates that Go's standard os.TempDir() did not return a directory.

	  var ErrOpen error
		ErrOpen indicates that we failed to open the buffer file.

	  var ErrRead error
		ErrRead indicates that we failed to read the buffer file's content.

	  var ErrRemove error
		ErrRemove indicates that we failed to delete the buffer file.

	  var ErrStart error
		ErrStart indicates that the command to start the editor failed.

	  var ErrWrite error
		ErrWrite indicates that we failed to write the buffer to the file.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.