expect

package module

Go to main page

Versions in this module

v0

v0.4.0

Nov 6, 2026

Changes in this version

+ var ErrNoSessions = errors.New("expect: no sessions")

+ func Relay(ctx context.Context, routes []Route, opts ...ExpectOption) (err error)

type Background

+ func (b *Background) Pause(ctx context.Context) error

+ func (b *Background) Resume(ctx context.Context) error

+ type CallbackError struct

+ Kind CallbackFailure

+ func (e *CallbackError) Error() string

+ func (e *CallbackError) GoString() string

+ type CallbackFailure string

+ const CallbackExited

+ const CallbackPanicked

type Case

+ NoConsume bool

+ Sessions []*Session

+ type CaseLimitError struct

+ CaseIndex int

+ RuleIndex int

+ Scope RuleScope

+ SessionID SessionID

+ Source MatchSource

+ func (e *CaseLimitError) Error() string

+ func (e *CaseLimitError) GoString() string

type Event

+ SessionID SessionID

+ type Group struct

+ func NewGroup(sessions ...*Session) (*Group, error)

+ func (g *Group) Add(ctx context.Context, s *Session) error

+ func (g *Group) Expect(ctx context.Context, cases []Case, opts ...ExpectOption) (*Session, Result, error)

+ func (g *Group) Remove(ctx context.Context, s *Session) error

type InteractOption

+ func WithInteractCookedCallbacks() InteractOption

+ func WithInteractEcho(enabled bool) InteractOption

+ func WithInteractInputForward(enabled bool) InteractOption

+ func WithInteractInputTimeout(d time.Duration) InteractOption

+ func WithInteractOutputForward(enabled bool) InteractOption

type Op

+ const OpInteract

+ type Pacer func(offset int) time.Duration

type Result

+ SessionID SessionID

+ type Route struct

+ Cases []Case

+ ForwardMatches bool

+ Output io.Writer

+ QueueLimit int

+ Source *Session

+ Targets []*Session

+ type RouteError struct

+ Cause error

+ Source SessionID

+ Target SessionID

+ Written int

+ func (e *RouteError) Error() string

+ func (e *RouteError) GoString() string

+ func (e *RouteError) Unwrap() error

type Session

+ func (s *Session) ID() SessionID

+ func (s *Session) SendPaced(ctx context.Context, text string, pacer Pacer) (n int, err error)

+ func (s *Session) SetRules(r RuleSnapshot) error

+ type SessionError struct

+ Cause error

+ SessionID SessionID

+ func (e *SessionError) Error() string

+ func (e *SessionError) GoString() string

+ func (e *SessionError) Unwrap() error

+ type SessionID uint64

type TraceEvent

+ SessionID SessionID

v0.3.0

Nov 5, 2026

Changes in this version

type CompileError

+ func (e *CompileError) Unwrap() error

type Event

+ RuleIndex int

+ Scope RuleScope

+ Source MatchSource

type InteractOption

+ func WithInteractInputCases(cases ...Case) InteractOption

+ func WithInteractOutputCases(cases ...Case) InteractOption

+ type MatchSource uint8

+ const SourceInput

+ const SourceReceive

+ func (s MatchSource) String() string

type ResponseError

+ CaseIndex int

+ Scope RuleScope

+ Source MatchSource

type Result

+ Source MatchSource

type TraceEvent

+ RuleIndex int

+ Scope RuleScope

+ Source MatchSource

v0.2.0

Nov 5, 2026

Changes in this version

+ const NoTimeout

+ var ErrBreakUnsupported = errors.New("expect: transport break unsupported")

+ var ErrInvalidPattern = errors.New("expect: invalid pattern")

type Action

+ const ContinueKeepTimer

+ type Background struct

+ func (*Background) String() string

+ func (b *Background) Stop()

+ func (b *Background) Wait() (Result, error)

+ func (p *Background) GoString() string

type Capture

+ End int

+ Name string

+ Start int

type Case

+ Limit int

+ type CompileError struct

+ Code syntax.ErrorCode

+ func (e *CompileError) Error() string

+ type ConfigError struct

+ Option string

+ Reason string

+ func (e *ConfigError) Error() string

type Console — darwin/amd64, linux/amd64

+ func (*Console) String() string

+ func (c *Console) SendBreak(ctx context.Context, duration time.Duration) error

+ func (c *Console) SetEcho(enabled bool) error

+ func (c *Console) SetSize(rows, cols int) error

+ func (c *Console) Start(cmd *exec.Cmd) error

+ func (p *Console) GoString() string

type ConsoleOption — darwin/amd64, linux/amd64

+ func WithSize(rows, cols int) ConsoleOption

+ type ErrClass string

+ const ClassBusy

+ const ClassCanceled

+ const ClassClosed

+ const ClassDeadline

+ const ClassEOF

+ const ClassError

+ const ClassIdleTimeout

+ const ClassOK

+ const ClassTimeout

+ func (c ErrClass) String() string

type ExpectOption

+ func WithMatchOrder(order MatchOrder) ExpectOption

+ func WithNoConsume() ExpectOption

+ func WithRules(cases ...Case) ExpectOption

type Handler

+ func ReplyThenContinue(text string) Handler

+ func Then(response Response) Handler

+ type InteractOption func(*interactOptions) error

+ func WithEscape(key byte) InteractOption

+ func WithEscapeAction(key byte, response Response) InteractOption

+ func WithInteractCases(cases ...Case) InteractOption

+ func WithInteractExpectOptions(opts ...ExpectOption) InteractOption

+ type MatchOrder uint8

+ const Declaration

+ const Earliest

+ type Op string

+ const OpExpect

+ const OpSend

+ const OpSendAll

+ func (o Op) String() string

type Pattern

+ func Default() Pattern

+ func FullBuffer() Pattern

+ func Glob(pattern string) Pattern

+ func Timeout() Pattern

+ func (p Pattern) Fold() Pattern

type Result

+ End int

+ RuleIndex int

+ Scope RuleScope

+ Start int

+ func ExpectAny(ctx context.Context, sessions []*Session, cases []Case, opts ...ExpectOption) (int, Result, error)

+ func (r Result) Buffer() string

+ func (r Result) Capture(name string) (Capture, bool)

+ func (r Result) Indices(group int) (int, int, bool)

+ type RuleScope string

+ const ScopeAfter

+ const ScopeBefore

+ const ScopeCall

+ type RuleSnapshot struct

+ After []Case

+ Before []Case

type Session

+ func (*Session) String() string

+ func (p *Session) GoString() string

+ func (s *Session) Interact(ctx context.Context, input io.ReadCloser, output io.Writer, ...) (err error)

+ func (s *Session) InteractTerminal(ctx context.Context, input *os.File, output io.Writer, opts ...InteractOption) (err error)

+ func (s *Session) Rules() RuleSnapshot

+ func (s *Session) SendBreak(ctx context.Context, duration time.Duration) error

+ func (s *Session) SendNull(ctx context.Context, count int) (int, error)

+ func (s *Session) SendSlow(ctx context.Context, text string, chunk int, interval time.Duration) (n int, err error)

+ func (s *Session) StartBackground(ctx context.Context, cases []Case, opts ...ExpectOption) (*Background, error)

type SessionOption

+ func WithAfter(cases ...Case) SessionOption

+ func WithBefore(cases ...Case) SessionOption

+ func WithRemoveNulls(enabled bool) SessionOption

+ func WithSendOutput(writers ...io.Writer) SessionOption

+ func WithStripParity(enabled bool) SessionOption

+ func WithTrace(observers ...TraceObserver) SessionOption

+ type TraceEvent struct

+ Buffered int

+ CaseIndex int

+ End int

+ Matched bool

+ Pattern string

+ Start int

+ type TraceObserver func(TraceEvent)

v0.1.4

Nov 5, 2026

v0.1.3

Nov 5, 2026

Changes in this version

type Pattern

+ func Line(text string) Pattern

+ func (p Pattern) IsZero() bool

+ func (p Pattern) ValidateText() error

v0.1.2

Oct 30, 2026

v0.1.1

Oct 26, 2026

Changes in this version

+ var ErrPollUnsupported = errors.New("expect: OS polling unsupported")

type Console — darwin/amd64, linux/amd64

+ func (c *Console) TTY() *os.File

type ExpectOption

+ func WithDeclarationPriority() ExpectOption

+ func WithStreamingFallback(handler Handler) ExpectOption

type Pattern

+ func FromRegexp(re *regexp.Regexp) (Pattern, error)

+ type Redactor struct

+ func NewRedactor(secrets []string, replacement string) (*Redactor, error)

+ func (*Redactor) String() string

+ func (r *Redactor) Append(data []byte) []byte

+ func (r *Redactor) Finish() []byte

+ func (r *Redactor) GoString() string

+ func (r *Redactor) SetSecrets(secrets []string) ([]byte, error)

type Session

+ func (s *Session) Poll(ctx context.Context, cases []Case, opts ...ExpectOption) (Result, error)

+ func (s *Session) SendAll(ctx context.Context, text string) (int, error)

+ func (s *Session) SendAllPoll(ctx context.Context, text string) (int, error)

type SessionOption

+ func WithOSPolling() SessionOption

v0.1.0

Oct 25, 2026

Changes in this version

+ var ErrBufferLimit = errors.New("expect: buffer limit reached")

+ var ErrBusy = errors.New("expect: another expect operation is active")

+ var ErrClosed = errors.New("expect: session closed")

+ var ErrEmptyMatch = errors.New("expect: empty match")

+ var ErrIdleTimeout = errors.New("expect: idle timeout")

+ var ErrTimeout = errors.New("expect: timeout")

+ type Action uint8

+ const Continue

+ const ContinueWithoutReset

+ const Return

+ type Capture struct

+ Matched bool

+ Text string

+ func (Capture) String() string

+ func (c Capture) GoString() string

+ type Case struct

+ Handler Handler

+ Pattern Pattern

+ func (Case) String() string

+ func (c Case) GoString() string

+ type Console struct — darwin/amd64, linux/amd64

+ func NewConsole(opts ...ConsoleOption) (*Console, error)

+ func (c *Console) Close() error

+ func (c *Console) Session() *Session

+ func (c *Console) Tty() *os.File

+ type ConsoleOption func(*consoleOptions) error — darwin/amd64, linux/amd64

+ func WithRaw() ConsoleOption

+ func WithSessionOptions(opts ...SessionOption) ConsoleOption

+ type Event struct

+ Bytes int

+ CaseIndex int

+ Error string

+ Operation string

+ type ExpectOption func(*expectOptions) error

+ func WithIdleTimeout(d time.Duration) ExpectOption

+ func WithTimeout(d time.Duration) ExpectOption

+ type Handler func(context.Context, *Session, Result) (Action, error)

+ type Observer func(Event)

+ type Pattern struct

+ func All(patterns ...Pattern) Pattern

+ func Compile(expr string) (Pattern, error)

+ func EOF() Pattern

+ func Literal(text string) Pattern

+ func (p Pattern) GoString() string

+ func (p Pattern) String() string

+ type Responder struct

+ func NewResponder(rules ...Rule) (*Responder, error)

+ func (r *Responder) Expect(ctx context.Context, s *Session, completion []Pattern, opts ...ExpectOption) (Result, error)

+ func (r *Responder) GoString() string

+ func (r *Responder) String() string

+ type Response func(context.Context, *Session, Result) error

+ func Reply(text string) Response

+ type ResponseError struct

+ RuleIndex int

+ func (e *ResponseError) Error() string

+ type Result struct

+ Before string

+ Captures []Capture

+ CaseIndex int

+ Match string

+ func (r Result) GoString() string

+ func (r Result) String() string

+ type Rule struct

+ Limit int

+ Pattern Pattern

+ Respond Response

+ func (Rule) String() string

+ func (r Rule) GoString() string

+ type Session struct

+ func NewSession(transport io.ReadWriteCloser, opts ...SessionOption) (*Session, error)

+ func (s *Session) Close() error

+ func (s *Session) Expect(ctx context.Context, cases []Case, opts ...ExpectOption) (Result, error)

+ func (s *Session) Redact(secrets ...string) error

+ func (s *Session) Send(ctx context.Context, text string) (n int, err error)

+ func (s *Session) SendLine(ctx context.Context, text string) (int, error)

+ type SessionOption func(*sessionOptions) error

+ func WithBufferLimit(n int) SessionOption

+ func WithDefaultTimeout(d time.Duration) SessionOption

+ func WithLineEnding(s string) SessionOption

+ func WithLogger(l *log.Logger) SessionOption

+ func WithObserver(observers ...Observer) SessionOption

+ func WithOutput(writers ...io.Writer) SessionOption

+ func WithTranscript(w io.Writer) SessionOption

+ func WithWriteTimeout(d time.Duration) SessionOption

+ type WriteError struct

+ Cause error

+ Written int

+ func (e *WriteError) Error() string

+ func (e *WriteError) GoString() string

+ func (e *WriteError) Unwrap() error

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