stream

package

v0.1.12 Latest Latest Go to latest Published: Feb 9, 2024 License: MIT Imports: 12 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/cfoust/cy

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Cmd
- func NewCmd(ctx context.Context, options CmdOptions, size Size) (*Cmd, error)
type CmdOptions
type CmdStatus
type Notifier
type Reader
- func NewReader() *Reader
type Screen
type Size
type Stream

Constants ¶

View Source

const (
	SPIN_NUM_TRIES = 3
	SPIN_THRESHOLD = 1 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Cmd ¶

type Cmd struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func NewCmd ¶

func NewCmd(ctx context.Context, options CmdOptions, size Size) (*Cmd, error)

func (*Cmd) GetStatus ¶

func (c *Cmd) GetStatus() CmdStatus

func (*Cmd) Path ¶

func (c *Cmd) Path() (string, error)

func (*Cmd) Read ¶

func (c *Cmd) Read(p []byte) (n int, err error)

func (*Cmd) Resize ¶

func (c *Cmd) Resize(size Size) error

func (c *Cmd) Subscribe(ctx context.Context) *util.Subscriber[CmdStatus]

func (*Cmd) Write ¶

func (c *Cmd) Write(data []byte) (n int, err error)

type CmdOptions ¶

type CmdOptions struct {
	Directory string
	Command   string
	Args      []string
}

type CmdStatus ¶

type CmdStatus int

const (
	CmdStatusStarting CmdStatus = iota
	CmdStatusHealthy
	CmdStatusFailed
)

type Notifier ¶

type Notifier = mux.Updater

type Reader ¶

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

func NewReader ¶

func NewReader() *Reader

func (*Reader) Read ¶

func (s *Reader) Read(p []byte) (n int, err error)

func (*Reader) Resize ¶

func (s *Reader) Resize(size Size) error

Resizing does nothing to a stream.

func (*Reader) Write ¶

func (s *Reader) Write(data []byte) (n int, err error)

func (*Reader) Writer ¶

func (s *Reader) Writer() io.Writer

Return the handle that allows you to write to this stream.

type Screen ¶

type Screen = mux.Screen

type Size ¶

type Size = mux.Size

type Stream ¶

type Stream = mux.Stream

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cli
renderer

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