file

Documentation

Index

• type File
• type Logger
• type ReceiveState
• type Receiver
  • func NewReceiver(syslog *zap.SugaredLogger, fs WriteFS, opts ...RecvOpt) *Receiver
  • func (i *Receiver) Next(req *executorv1.FileTransfer) (err error)
  • func (i *Receiver) State() ReceiveState
• type RecvCallback
• type RecvOpt
  • func WithRecvCallback(cb RecvCallback) RecvOpt
• type RecvOpts
• type SendCallback
• type SendOpt
  • func WithDest(dest string) SendOpt
  • func WithExcludes(excludes []string) SendOpt
  • func WithSendCallback(cb SendCallback) SendOpt
  • func WithSkipCallback(cb SkipCallback) SendOpt
• type SendOpts
• type SendResult
• type SendTransport
• type Sender
  • func NewSender(syslog *zap.SugaredLogger, fs fs.FS, transport SendTransport, runtimeID string, ...) *Sender
  • func (s *Sender) Send(src string) (*SendResult, error)
• type SkipCallback
• type WriteFS
  • func WriteDirFS(baseDir string) WriteFS

Types

type File

type File interface {
	io.ReadWriteCloser
	io.Seeker
}

type Logger

type Logger interface {
	Printf(format string, args ...interface{})
}

type ReceiveState

type ReceiveState int

const (
	ReceiveStateAwaitingHeaders ReceiveState = iota
	ReceiveStateAwaitingBody
	ReceiveStateAwaitingTrailer
	ReceiveStateDone
)

type Receiver

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

func NewReceiver

func NewReceiver(syslog *zap.SugaredLogger, fs WriteFS, opts ...RecvOpt) *Receiver

func (*Receiver) Next

func (i *Receiver) Next(req *executorv1.FileTransfer) (err error)

func (*Receiver) State

func (i *Receiver) State() ReceiveState

type RecvCallback

type RecvCallback func(header *executorv1.FileTransferHeader)

type RecvOpt

type RecvOpt interface {
	Apply(*RecvOpts)
}

func WithRecvCallback

func WithRecvCallback(cb RecvCallback) RecvOpt

type RecvOpts

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

type SendCallback

type SendCallback func(header *executorv1.FileTransferHeader)

type SendOpt

type SendOpt interface {
	Apply(*SendOpts)
}

func WithDest

func WithDest(dest string) SendOpt

func WithExcludes

func WithExcludes(excludes []string) SendOpt

func WithSendCallback

func WithSendCallback(cb SendCallback) SendOpt

func WithSkipCallback

func WithSkipCallback(cb SkipCallback) SendOpt

type SendOpts

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

type SendResult

type SendResult struct{}

type SendTransport

type SendTransport interface {
	Send(*executorv1.FileTransfer) error
}

type Sender

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

func NewSender

func NewSender(syslog *zap.SugaredLogger, fs fs.FS, transport SendTransport, runtimeID string, transferID string, opts ...SendOpt) *Sender

func (*Sender) Send

func (s *Sender) Send(src string) (*SendResult, error)

type SkipCallback

type SkipCallback func(path string, isDir bool, excludedBy string)

type WriteFS

type WriteFS interface {
	ReadFS() fs.FS
	Directory() string
	MkdirAll(path string, perm os.FileMode) error
	OpenFile(name string, flag int, perm os.FileMode) (File, error)
}

func WriteDirFS

func WriteDirFS(baseDir string) WriteFS