consolestream

package module

Go to main page

Versions in this module

v0

v0.4.0

Dec 31, 2025

Changes in this version

+ func IsContainerCreateEvent(event StreamEvent) bool

+ func IsContainerRemoveEvent(event StreamEvent) bool

+ type ContainerCreate struct

+ ContainerID string

+ Image string

+ func (c *ContainerCreate) String() string

+ func (c *ContainerCreate) Type() EventType

+ type ContainerMount struct

+ ReadOnly bool

+ Source string

+ Target string

+ type ContainerProcess struct

+ func NewContainerProcess(cmd string, args []string, opts ...ContainerProcessOption) *ContainerProcess

+ func (cp *ContainerProcess) ExecuteAndStream(ctx context.Context) iter.Seq2[Event, error]

+ type ContainerProcessOption func(*containerProcessConfig)

+ func WithContainerCancellor(cancellor Cancellor) ContainerProcessOption

+ func WithContainerEnv(env []string) ContainerProcessOption

+ func WithContainerEnvMap(envMap map[string]string) ContainerProcessOption

+ func WithContainerFlushInterval(interval time.Duration) ContainerProcessOption

+ func WithContainerImage(image string) ContainerProcessOption

+ func WithContainerMaxBufferSize(size int) ContainerProcessOption

+ func WithContainerMeter(meter any) ContainerProcessOption

+ func WithContainerMetricsInterval(interval time.Duration) ContainerProcessOption

+ func WithContainerMount(source, target string, readOnly bool) ContainerProcessOption

+ func WithContainerRuntime(runtime string) ContainerProcessOption

+ func WithContainerWorkingDir(dir string) ContainerProcessOption

+ type ContainerRemove struct

+ ContainerID string

+ func (c *ContainerRemove) String() string

+ func (c *ContainerRemove) Type() EventType

type EventType

+ const ContainerCreateEvent

+ const ContainerRemoveEvent

+ const ImagePullCompleteEvent

+ const ImagePullProgressEvent

+ const ImagePullStartEvent

+ type ImagePullComplete struct

+ Digest string

+ Image string

+ func (i *ImagePullComplete) String() string

+ func (i *ImagePullComplete) Type() EventType

+ type ImagePullProgress struct

+ BytesDownloaded int64

+ BytesTotal int64

+ Image string

+ PercentComplete int

+ Status string

+ func (i *ImagePullProgress) String() string

+ func (i *ImagePullProgress) Type() EventType

+ type ImagePullStart struct

+ Image string

+ func (i *ImagePullStart) String() string

+ func (i *ImagePullStart) Type() EventType

v0.3.3

Dec 21, 2025

v0.3.2

Dec 21, 2025

Changes in this version

type ProcessOption

+ func WithWorkingDir(dir string) ProcessOption

v0.3.1

Oct 25, 2025

v0.3.0

Sep 23, 2025

Changes in this version

+ func IsOutputEvent(event StreamEvent) bool

type EventType

+ const OutputEvent

+ type OutputData struct

+ Data []byte

+ func (o *OutputData) String() string

+ func (o *OutputData) Type() EventType

+ type Process struct

+ func NewProcess(cmd string, args []string, opts ...ProcessOption) *Process

+ func (p *Process) ExecuteAndStream(ctx context.Context) iter.Seq2[Event, error]

+ func (p *Process) GetStats() ProcessStatsSnapshot

+ type ProcessMode int

+ const PTYMode

+ const PipeMode

+ func (m ProcessMode) String() string

type ProcessOption

+ func WithPTYMode() ProcessOption

+ func WithPipeMode() ProcessOption

+ type ProcessStats struct

+ func NewProcessStats(meter metric.Meter, interval time.Duration, processInfo ProcessInfo) (*ProcessStats, error)

+ func (s *ProcessStats) GetSnapshot() ProcessStatsSnapshot

+ func (s *ProcessStats) RecordError(ctx context.Context, eventType string)

+ func (s *ProcessStats) RecordEvent(ctx context.Context, eventType string)

+ func (s *ProcessStats) RecordOutput(ctx context.Context, dataSize int64)

+ func (s *ProcessStats) SetExitCode(code int)

+ func (s *ProcessStats) Start(ctx context.Context)

+ func (s *ProcessStats) Stop(ctx context.Context)

+ type ProcessStatsSnapshot struct

+ Duration time.Duration

+ ErrorCount int

+ EventCount int

+ ExitCode *int

+ StartTime time.Time

v0.2.1

Sep 23, 2025

Changes in this version

type PTYProcess

+ func (p *PTYProcess) GetStats() PTYStatsSnapshot

+ type PTYStats struct

+ func NewPTYStats(meter metric.Meter, interval time.Duration, processInfo ProcessInfo) (*PTYStats, error)

+ func (s *PTYStats) GetSnapshot() PTYStatsSnapshot

+ func (s *PTYStats) RecordError(ctx context.Context, eventType string)

+ func (s *PTYStats) RecordEvent(ctx context.Context, eventType string)

+ func (s *PTYStats) RecordOutput(ctx context.Context, dataSize int64)

+ func (s *PTYStats) SetExitCode(code int)

+ func (s *PTYStats) Start(ctx context.Context)

+ func (s *PTYStats) Stop(ctx context.Context)

+ type PTYStatsSnapshot struct

+ Duration time.Duration

+ ErrorCount int

+ EventCount int

+ ExitCode *int

+ StartTime time.Time

+ type ProcessInfo struct

+ Args []string

+ Command string

+ PID int

type ProcessOption

+ func WithMeter(meter any) ProcessOption

+ func WithMetricsInterval(interval time.Duration) ProcessOption

v0.2.0

Sep 22, 2025

Changes in this version

+ type BufferWriter struct

+ func NewBufferWriter(flushChan chan<- struct{}, maxBufferSize int) *BufferWriter

+ func (w *BufferWriter) Close() error

+ func (w *BufferWriter) FlushAndClear() []byte

+ func (w *BufferWriter) Len() int

+ func (w *BufferWriter) Write(data []byte) (int, error)

v0.1.0

Sep 21, 2025

Changes in this version

+ func IsHeartbeatEvent(event StreamEvent) bool

+ func IsPTYOutputEvent(event StreamEvent) bool

+ func IsPipeOutputEvent(event StreamEvent) bool

+ func IsProcessEndEvent(event StreamEvent) bool

+ func IsProcessErrorEvent(event StreamEvent) bool

+ func IsProcessLifecycleEvent(event StreamEvent) bool

+ func IsProcessStartEvent(event StreamEvent) bool

+ func IsTerminalResizeEvent(event StreamEvent) bool

+ func ToAscicastV3(events iter.Seq2[Event, error], metadata AscicastV3Metadata) iter.Seq2[AscicastV3Line, error]

+ func WriteAscicastV3(events iter.Seq2[Event, error], metadata AscicastV3Metadata, ...) error

+ type AscicastV3Event [3]any

+ func NewExitEvent(interval float64, exitCode int) AscicastV3Event

+ func NewOutputEvent(interval float64, data []byte) AscicastV3Event

+ func NewResizeEvent(interval float64, cols, rows uint16) AscicastV3Event

+ func (e AscicastV3Event) MarshalJSON() ([]byte, error)

+ type AscicastV3Header struct

+ Version int

+ func (h AscicastV3Header) MarshalJSON() ([]byte, error)

+ type AscicastV3Line interface

+ MarshalJSON func() ([]byte, error)

+ type AscicastV3Metadata struct

+ Command string

+ Env map[string]string

+ Tags []string

+ Term TermInfo

+ Timestamp *time.Time

+ Title string

+ type Cancellor interface

+ Cancel func(ctx context.Context, pid int) error

+ type Event struct

+ Event StreamEvent

+ Timestamp time.Time

+ func (e Event) EventType() EventType

+ func (e Event) String() string

+ type EventType int

+ const HeartbeatEventType

+ const PTYOutputEvent

+ const PipeOutputEvent

+ const ProcessEndEvent

+ const ProcessErrorEvent

+ const ProcessStartEvent

+ const TerminalResizeEventType

+ func (e EventType) String() string

+ type HeartbeatEvent struct

+ ElapsedTime time.Duration

+ ProcessAlive bool

+ func (h *HeartbeatEvent) String() string

+ func (h *HeartbeatEvent) Type() EventType

+ type LocalCancellor struct

+ func NewLocalCancellor(terminateTimeout time.Duration) *LocalCancellor

+ func (lc *LocalCancellor) Cancel(ctx context.Context, pid int) error

+ type PTYOutputData struct

+ Data []byte

+ func (p *PTYOutputData) String() string

+ func (p *PTYOutputData) Type() EventType

+ type PTYProcess struct

+ func NewPTYProcess(cmd string, args []string, opts ...ProcessOption) *PTYProcess

+ func (p *PTYProcess) ExecuteAndStream(ctx context.Context) iter.Seq2[Event, error]

+ type PipeOutputData struct

+ Data []byte

+ Stream StreamType

+ func (o *PipeOutputData) String() string

+ func (o *PipeOutputData) Type() EventType

+ type PipeProcess struct

+ func NewPipeProcess(cmd string, args []string, opts ...ProcessOption) *PipeProcess

+ func (p *PipeProcess) ExecuteAndStream(ctx context.Context) iter.Seq2[Event, error]

+ type PipeProcessFailedError struct

+ Cmd string

+ ExitCode int

+ func (e PipeProcessFailedError) Error() string

+ type PipeProcessKilledError struct

+ Cmd string

+ Signal string

+ func (e PipeProcessKilledError) Error() string

+ type ProcessEnd struct

+ Duration time.Duration

+ ExitCode int

+ Success bool

+ func (p *ProcessEnd) String() string

+ func (p *ProcessEnd) Type() EventType

+ type ProcessError struct

+ Error error

+ Message string

+ func (p *ProcessError) String() string

+ func (p *ProcessError) Type() EventType

+ type ProcessOption func(*processConfig)

+ func WithCancellor(cancellor Cancellor) ProcessOption

+ func WithEnv(env []string) ProcessOption

+ func WithEnvMap(envMap map[string]string) ProcessOption

+ func WithEnvVar(key, value string) ProcessOption

+ func WithFlushInterval(interval time.Duration) ProcessOption

+ func WithMaxBufferSize(size int) ProcessOption

+ func WithPTYSize(size pty.Winsize) ProcessOption

+ type ProcessStart struct

+ Args []string

+ Command string

+ PID int

+ func (p *ProcessStart) String() string

+ func (p *ProcessStart) Type() EventType

+ type ProcessStartError struct

+ Cmd string

+ Err error

+ func (e ProcessStartError) Error() string

+ type StreamEvent interface

+ String func() string

+ Type func() EventType

+ type StreamType int

+ const Stderr

+ const Stdout

+ func (s StreamType) String() string

+ type TermInfo struct

+ Cols int

+ Rows int

+ type TerminalResizeEvent struct

+ Cols uint16

+ Rows uint16

+ X uint16

+ Y uint16

+ func (t *TerminalResizeEvent) String() string

+ func (t *TerminalResizeEvent) Type() EventType

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