streams

package

v0.3.7 Latest Latest Go to latest Published: Jan 24, 2024 License: Apache-2.0 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/camerondurham/ch

Links

Open Source Insights

Documentation ¶

Index ¶

type HijackedIOStreamer
- func (h *HijackedIOStreamer) Stream(ctx context.Context) error
type In
- func NewIn(in io.ReadCloser) *In
type Out
- func NewOut(out io.Writer) *Out
type Streams

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type HijackedIOStreamer ¶

type HijackedIOStreamer struct {
	Streams      Streams
	InputStream  io.ReadCloser
	OutputStream io.Writer
	ErrorStream  io.Writer

	Resp types.HijackedResponse

	Tty bool
	// contains filtered or unexported fields
}

func (*HijackedIOStreamer) Stream ¶

func (h *HijackedIOStreamer) Stream(ctx context.Context) error

type In ¶

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

In is an input Stream used by the DockerCli to read user input

func NewIn ¶

func NewIn(in io.ReadCloser) *In

NewIn returns a new In object from a ReadCloser

func (*In) CheckTty ¶

func (i *In) CheckTty(attachStdin, ttyMode bool) error

CheckTty checks if we are trying to attach to a container Tty from a non-Tty client input Stream, and if so, returns an error.

func (*In) Close ¶

func (i *In) Close() error

Close implements the Closer interface

func (*In) FD ¶

func (s *In) FD() uintptr

FD returns the file descriptor number for this Stream

func (*In) IsTerminal ¶

func (s *In) IsTerminal() bool

IsTerminal returns true if this Stream is connected to a terminal

func (*In) Read ¶

func (i *In) Read(p []byte) (int, error)

func (*In) RestoreTerminal ¶

func (s *In) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal

func (*In) SetIsTerminal ¶

func (s *In) SetIsTerminal(isTerminal bool)

SetIsTerminal sets the boolean used for isTerminal

func (*In) SetRawTerminal ¶

func (i *In) SetRawTerminal() (err error)

SetRawTerminal sets raw mode on the input terminal

type Out ¶

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

Out is an output Stream used by the DockerCli to write normal program output.

func NewOut ¶

func NewOut(out io.Writer) *Out

NewOut returns a new Out object from a Writer

func (*Out) FD ¶

func (s *Out) FD() uintptr

FD returns the file descriptor number for this Stream

func (*Out) GetTtySize ¶

func (o *Out) GetTtySize() (uint, uint)

GetTtySize returns the height and width in characters of the Tty

func (*Out) IsTerminal ¶

func (s *Out) IsTerminal() bool

IsTerminal returns true if this Stream is connected to a terminal

func (*Out) RestoreTerminal ¶

func (s *Out) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal

func (*Out) SetIsTerminal ¶

func (s *Out) SetIsTerminal(isTerminal bool)

SetIsTerminal sets the boolean used for isTerminal

func (*Out) SetRawTerminal ¶

func (o *Out) SetRawTerminal() (err error)

SetRawTerminal sets raw mode on the input terminal

func (*Out) Write ¶

func (o *Out) Write(p []byte) (int, error)

type Streams ¶

type Streams interface {
	In() *In
	Out() *Out
	Err() io.Writer
}

Streams is an interface which exposes the standard input and output streams

Source Files ¶

View all Source files

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