fsio

Documentation

Index

• func NopWriteCloser(w io.Writer) io.WriteCloser
• func TryFlush(w io.Writer) error
• type AsyncWriter
  • func (aw *AsyncWriter) Close() error
  • func (aw *AsyncWriter) LastWriteStatus() WriteStatus
  • func (aw *AsyncWriter) Write(p []byte) (n int, err error)
• type Flusher
• type MutexWriter
  • func NewMutexWriter(w io.Writer) *MutexWriter
  • func (w *MutexWriter) WithLock(fn func(w io.Writer))
  • func (w *MutexWriter) WithRLock(fn func(w io.Writer))
  • func (w *MutexWriter) Write(b []byte) (int, error)
• type ResetWriter
  • func NewResetWriter(w io.Writer) ResetWriter
• type WriteStatus

Functions

func NopWriteCloser

func NopWriteCloser(w io.Writer) io.WriteCloser

NopWriteCloser nop closer for writer

func TryFlush

func TryFlush(w io.Writer) error

TryFlush try flush

Types

type AsyncWriter

type AsyncWriter struct {
	// Writer 实际 writer，必填
	Writer io.Writer

	// ChanSize 异步队列大小，可选
	// 默认为 1024。当值为 -1 时，chanSize=0，即变为同步
	ChanSize int

	// NeedStatus 是否需要 write 的状态
	NeedStatus bool
	// contains filtered or unexported fields
}

AsyncWriter 异步化的 writer

func (*AsyncWriter) Close

func (aw *AsyncWriter) Close() error

Close 关闭

func (*AsyncWriter) LastWriteStatus

func (aw *AsyncWriter) LastWriteStatus() WriteStatus

LastWriteStatus 返回的是异步写的最新一次的状态

func (*AsyncWriter) Write

func (aw *AsyncWriter) Write(p []byte) (n int, err error)

Write 异步写

type Flusher

type Flusher interface {
	Flush() error
}

Flusher can flush

type MutexWriter

type MutexWriter struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

func NewMutexWriter

func NewMutexWriter(w io.Writer) *MutexWriter

NewMutexWriter wrap a writer with a mutex

func (*MutexWriter) WithLock

func (w *MutexWriter) WithLock(fn func(w io.Writer))

func (*MutexWriter) WithRLock

func (w *MutexWriter) WithRLock(fn func(w io.Writer))

func (*MutexWriter) Write

func (w *MutexWriter) Write(b []byte) (int, error)

type ResetWriter

type ResetWriter interface {
	io.Writer
	Reset(w io.Writer)
}

ResetWriter writer can reset

func NewResetWriter

func NewResetWriter(w io.Writer) ResetWriter

NewResetWriter wrap writer to ResetWriter

type WriteStatus

type WriteStatus struct {
	Err   error
	Wrote int
}

WriteStatus status for Write