kautorw

Documentation

Index

• Constants
• func ReadClip(fns ...ReaderFn) (string, error)
• func ReadContents(src string, fns ...ReaderFn) (string, error)
• func ReadStdin(fns ...ReaderFn) (string, error)
• func WriteContents(contents, dst string) (string, error)
• type ReaderFn
  • func TryStdinOnEmpty() ReaderFn
  • func WithCheckResult() ReaderFn
  • func WithDefaultAsFile() ReaderFn
  • func WithTrimSpace() ReaderFn
  • func WithTypeOnEmpty(typ string) ReaderFn
• type SourceReader
  • func NewSourceReader(src string, fns ...ReaderFn) *SourceReader
  • func (r *SourceReader) Buffer() *bytes.Buffer
  • func (r *SourceReader) Err() error
  • func (r *SourceReader) HasRead() bool
  • func (r *SourceReader) ReadClip() *SourceReader
  • func (r *SourceReader) ReadStdin() *SourceReader
  • func (r *SourceReader) ReadString() string
  • func (r *SourceReader) Reset() *SourceReader
  • func (r *SourceReader) SrcType() string
  • func (r *SourceReader) TryReadString() (string, error)
  • func (r *SourceReader) TryString() (string, error)
  • func (r *SourceReader) Type() string
  • func (r *SourceReader) WithConfig(fns ...ReaderFn) *SourceReader
• type SourceWriter
  • func NewSourceWriter(dst string) *SourceWriter
  • func (w *SourceWriter) CleanAndGet() *bytes.Buffer
  • func (w *SourceWriter) DstType() string
  • func (w *SourceWriter) HasSrcFile() bool
  • func (w *SourceWriter) SetSrcFile(srcPath string)
  • func (w *SourceWriter) StartFlush()
  • func (w *SourceWriter) StopFlush() error
  • func (w *SourceWriter) WithDst(dst string) *SourceWriter
  • func (w *SourceWriter) Write(bs []byte) (err error)
  • func (w *SourceWriter) WriteFrom(r io.Reader) error
  • func (w *SourceWriter) WriteString(s string) (err error)
• type WriterFn
  • func FallbackStdout() WriterFn

Constants

const (
	DstStdin  = "@stdin"
	DstStdout = "@stdout"
	DstClip   = "@clip"
	DstSrc    = "@src" // src file path
)

types for read or write

const (
	TypeStdin  = "stdin"
	TypeString = "string" // raw string
	TypeStdout = "stdout"

	TypeClip = "clip"
	TypeFile = "file"
)

types for read or write

Functions

func ReadClip

func ReadClip(fns ...ReaderFn) (string, error)

func ReadContents

func ReadContents(src string, fns ...ReaderFn) (string, error)

func ReadStdin

func ReadStdin(fns ...ReaderFn) (string, error)

func WriteContents

func WriteContents(contents, dst string) (string, error)

Types

type ReaderFn

type ReaderFn func(r *SourceReader)

ReaderFn type

func TryStdinOnEmpty

func TryStdinOnEmpty() ReaderFn

TryStdinOnEmpty try read from stdin.

func WithCheckResult

func WithCheckResult() ReaderFn

WithCheckResult on read contents.

func WithDefaultAsFile

func WithDefaultAsFile() ReaderFn

WithDefaultAsFile on read contents.

func WithTrimSpace

func WithTrimSpace() ReaderFn

WithTrimSpace on read contents.

func WithTypeOnEmpty

func WithTypeOnEmpty(typ string) ReaderFn

WithTypeOnEmpty setting.

type SourceReader

type SourceReader struct {

	// TypeOnEmpty operate type on src is empty.
	TypeOnEmpty string
	// DefaultAsFile type on src type not match.
	DefaultAsFile bool
	// TrimSpace for read contents
	TrimSpace bool
	// CheckResult return error on result is empty
	CheckResult bool
	// contains filtered or unexported fields
}

SourceReader struct

func NewSourceReader

func NewSourceReader(src string, fns ...ReaderFn) *SourceReader

NewSourceReader instance

func (*SourceReader) Buffer

func (r *SourceReader) Buffer() *bytes.Buffer

Buffer get

func (*SourceReader) Err

func (r *SourceReader) Err() error

Err get

func (*SourceReader) HasRead

func (r *SourceReader) HasRead() bool

HasRead bool

func (*SourceReader) ReadClip

func (r *SourceReader) ReadClip() *SourceReader

ReadClip return string and error

func (*SourceReader) ReadStdin

func (r *SourceReader) ReadStdin() *SourceReader

ReadStdin handle

func (*SourceReader) ReadString

func (r *SourceReader) ReadString() string

ReadString return string

func (*SourceReader) Reset

func (r *SourceReader) Reset() *SourceReader

Reset buffer

func (*SourceReader) SrcType

func (r *SourceReader) SrcType() string

SrcType get

func (*SourceReader) TryReadString

func (r *SourceReader) TryReadString() (string, error)

TryReadString return string and error

func (*SourceReader) TryString

func (r *SourceReader) TryString() (string, error)

TryString return string and error

func (*SourceReader) Type

func (r *SourceReader) Type() string

Type get

func (*SourceReader) WithConfig

func (r *SourceReader) WithConfig(fns ...ReaderFn) *SourceReader

WithConfig setting.

type SourceWriter

type SourceWriter struct {

	// FallbackType operate type on dst is empty.
	FallbackType string
	// contains filtered or unexported fields
}

SourceWriter struct

func NewSourceWriter

func NewSourceWriter(dst string) *SourceWriter

NewSourceWriter create a new instance

func (*SourceWriter) CleanAndGet

func (w *SourceWriter) CleanAndGet() *bytes.Buffer

CleanAndGet clean flush buffer, and get buffer object.

func (*SourceWriter) DstType

func (w *SourceWriter) DstType() string

DstType get dst type name

func (*SourceWriter) HasSrcFile

func (w *SourceWriter) HasSrcFile() bool

HasSrcFile check has src file

func (*SourceWriter) SetSrcFile

func (w *SourceWriter) SetSrcFile(srcPath string)

SetSrcFile set src file path

func (*SourceWriter) StartFlush

func (w *SourceWriter) StartFlush()

StartFlush start flush buffer contents to dst

func (*SourceWriter) StopFlush

func (w *SourceWriter) StopFlush() error

StopFlush flush all buffer contents to dst

func (*SourceWriter) WithDst

func (w *SourceWriter) WithDst(dst string) *SourceWriter

WithDst set dst target

func (*SourceWriter) Write

func (w *SourceWriter) Write(bs []byte) (err error)

WriteString write string to dst

func (*SourceWriter) WriteFrom

func (w *SourceWriter) WriteFrom(r io.Reader) error

WriteFrom write data from reader

func (*SourceWriter) WriteString

func (w *SourceWriter) WriteString(s string) (err error)

WriteString write string to dst

type WriterFn

type WriterFn func(w *SourceWriter)

WriterFn type

func FallbackStdout

func FallbackStdout() WriterFn

FallbackStdout write to stdout.