putxt

README

PuTXT

NOTE: This API is anything but stable

Documentation

Index

• Constants
• func IsText(s []byte) bool
• type Handler
• type Logger
• type TermDumpster
  • func NewTermDumpster(handler Handler) *TermDumpster
  • func (td *TermDumpster) Listen(addr string, port string) error
  • func (td *TermDumpster) ListenUnixSocket(path string) error
  • func (td *TermDumpster) WithGzip() *TermDumpster
  • func (td *TermDumpster) WithLogger(logger Logger) *TermDumpster
  • func (td *TermDumpster) WithMaxSize(size int64) *TermDumpster
  • func (td *TermDumpster) WithTimeout(timeout time.Duration) *TermDumpster

Constants

const (
	MessageRatelimited   = "RATELIMIT_REACHED"
	MessageSizeLimited   = "MAX_SIZE_EXCEEDED"
	MessageBinaryData    = "BINARY_DATA_REJECTED"
	MessageInternalError = "INTERNAL_ERROR"
)

Functions

func IsText

func IsText(s []byte) bool

slightly modified from golang.org/x/tools/godoc/util to include carriage return for dirty windows users

Types

type Handler

type Handler interface {
	Ingest(data []byte) ([]byte, error)
}

type Logger

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

type TermDumpster

type TermDumpster struct {
	Pool pool.BufferFactory
	*rate5.Limiter
	// contains filtered or unexported fields
}

func NewTermDumpster

func NewTermDumpster(handler Handler) *TermDumpster

func (*TermDumpster) Listen

func (td *TermDumpster) Listen(addr string, port string) error

Listen starts the TCP server

func (*TermDumpster) ListenUnixSocket

func (td *TermDumpster) ListenUnixSocket(path string) error

ListenUnixSocket starts the unix socket listener

func (*TermDumpster) WithGzip

func (td *TermDumpster) WithGzip() *TermDumpster

func (*TermDumpster) WithLogger

func (td *TermDumpster) WithLogger(logger Logger) *TermDumpster

func (*TermDumpster) WithMaxSize

func (td *TermDumpster) WithMaxSize(size int64) *TermDumpster

func (*TermDumpster) WithTimeout

func (td *TermDumpster) WithTimeout(timeout time.Duration) *TermDumpster