robocat

Documentation

Index

• type Client
  • func Connect(u string, credentials ...Credentials) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Flow(flow string) *FlowCommandChain
  • func (c *Client) Input(path string, content []byte) error
  • func (c *Client) Ping() error
  • func (c *Client) SetLogger(logger *Logger)
  • func (c *Client) SetSizeLimit(limit string) error
  • func (c *Client) Stop() error
• type Credentials
  • func (c *Credentials) GetUserInfo() *url.Userinfo
• type File
  • func (f *File) Image() (image.Image, string, error)
  • func (f *File) Kind() string
  • func (f *File) Text() string
  • func (f *File) Type() string
• type FlowCommandChain
  • func (chain *FlowCommandChain) Run() *RobocatFlow
  • func (chain *FlowCommandChain) WithData(data string) *FlowCommandChain
  • func (chain *FlowCommandChain) WithProxy(proxy string) *FlowCommandChain
  • func (chain *FlowCommandChain) WithTimeout(timeout time.Duration) *FlowCommandChain
• type Logger
• type RobocatFileStream
• type RobocatFlow
  • func (f *RobocatFlow) Done() <-chan struct{}
  • func (f *RobocatFlow) Err() error
  • func (f *RobocatFlow) Files() *RobocatFileStream
  • func (f *RobocatFlow) Log() *RobocatLogStream
  • func (f *RobocatFlow) Wait() error
• type RobocatInput
  • func (i *RobocatInput) Push(path string, mimeType string, content []byte) error
• type RobocatLogStream
• type RobocatStream
  • func (s *RobocatStream[T]) Channel() <-chan T
  • func (s *RobocatStream[T]) Close()
  • func (s *RobocatStream[T]) Push(item T) error
  • func (s *RobocatStream[T]) Watch(callback func(item T))
• type UpdateCallback

Types

type Client

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

func Connect

func Connect(u string, credentials ...Credentials) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) Flow

func (c *Client) Flow(flow string) *FlowCommandChain

func (*Client) Input

func (c *Client) Input(path string, content []byte) error

func (*Client) Ping

func (c *Client) Ping() error

func (*Client) SetLogger

func (c *Client) SetLogger(logger *Logger)

func (*Client) SetSizeLimit

func (c *Client) SetSizeLimit(limit string) error

Nax number of bytes to read for a single message. Limit must be in human-readable format (i.e. 10M, 50KB, etc) - for more details refer to https://pkg.go.dev/github.com/docker/go-units@v0.5.0#section-documentation

func (*Client) Stop

func (c *Client) Stop() error

type Credentials

type Credentials struct {
	Username string
	Password string
}

func (*Credentials) GetUserInfo

func (c *Credentials) GetUserInfo() *url.Userinfo

type File

type File struct {
	Path     string
	MimeType string
	Payload  []byte
}

func (*File) Image

func (f *File) Image() (image.Image, string, error)

Uses image.Decode to decode an image that has been encoded in a registered format. The string returned is the format name.

func (*File) Kind

func (f *File) Kind() string

Generic file kind extracted from MIME-type (i.e. text, image, etc).

func (*File) Text

func (f *File) Text() string

Converts transmitted payload to plain text and returns it as string.

func (*File) Type

func (f *File) Type() string

Complete MIME-type as provided by mime.ParseMediaType.

type FlowCommandChain

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

func (*FlowCommandChain) Run

func (chain *FlowCommandChain) Run() *RobocatFlow

func (*FlowCommandChain) WithData

func (chain *FlowCommandChain) WithData(data string) *FlowCommandChain

func (*FlowCommandChain) WithProxy

func (chain *FlowCommandChain) WithProxy(proxy string) *FlowCommandChain

func (*FlowCommandChain) WithTimeout

func (chain *FlowCommandChain) WithTimeout(timeout time.Duration) *FlowCommandChain

type Logger

type Logger struct {
	Debug func(args ...any)
	Error func(args ...any)
}

type RobocatFileStream

type RobocatFileStream struct {
	RobocatStream[*File]
}

type RobocatFlow

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

func (*RobocatFlow) Done

func (f *RobocatFlow) Done() <-chan struct{}

func (*RobocatFlow) Err

func (f *RobocatFlow) Err() error

func (*RobocatFlow) Files

func (f *RobocatFlow) Files() *RobocatFileStream

func (*RobocatFlow) Log

func (f *RobocatFlow) Log() *RobocatLogStream

func (*RobocatFlow) Wait

func (f *RobocatFlow) Wait() error

type RobocatInput

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

func (*RobocatInput) Push

func (i *RobocatInput) Push(
	path string,
	mimeType string,
	content []byte,
) error

type RobocatLogStream

type RobocatLogStream struct {
	RobocatStream[string]
}

type RobocatStream

type RobocatStream[T any] struct {
	// contains filtered or unexported fields
}

func (*RobocatStream[T]) Channel

func (s *RobocatStream[T]) Channel() <-chan T

Get read-only channel with stream items.

func (*RobocatStream[T]) Close

func (s *RobocatStream[T]) Close()

Mark stream as closed.

func (*RobocatStream[T]) Push

func (s *RobocatStream[T]) Push(item T) error

Append a new item to the stream.

func (*RobocatStream[T]) Watch

func (s *RobocatStream[T]) Watch(callback func(item T))

type UpdateCallback

type UpdateCallback func(context.Context, *ws.Message)