filestream

Documentation

Index

• type ReadCloser
• type Reader
  • func Open(path string, nocache bool) (*Reader, error)
  • func OpenReaderAt(path string, offset int64, nocache bool) (*Reader, error)
  • func (r *Reader) MustClose()
  • func (r *Reader) Read(p []byte) (int, error)
• type WriteCloser
• type Writer
  • func Create(path string, lockPath *string, nocache bool) (*Writer, error)
  • func OpenWriterAt(path string, lockPath *string, offset int64, nocache bool) (*Writer, error)
  • func (w *Writer) MustClose()
  • func (w *Writer) MustFlush(isSync bool)
  • func (w *Writer) Write(p []byte) (int, error)

Types

type ReadCloser

type ReadCloser interface {
	Read(p []byte) (int, error)
	MustClose()
}

ReadCloser is a standard interface for filestream Reader.

type Reader

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

Reader implements buffered file reader.

func Open

func Open(path string, nocache bool) (*Reader, error)

Open opens the file from the given path in nocache mode.

If nocache is set, then the reader doesn't pollute OS page cache.

func OpenReaderAt

func OpenReaderAt(path string, offset int64, nocache bool) (*Reader, error)

OpenReaderAt opens the file at the given path in nocache mode at the given offset.

If nocache is set, then the reader doesn't pollute OS page cache.

func (*Reader) MustClose

func (r *Reader) MustClose()

MustClose closes the underlying file passed to Open.

func (*Reader) Read

func (r *Reader) Read(p []byte) (int, error)

Read reads file contents to p.

type WriteCloser

type WriteCloser interface {
	Write(p []byte) (int, error)
	MustClose()
}

WriteCloser is a standard interface for filestream Writer.

type Writer

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

Writer implements buffered file writer.

func Create

func Create(path string, lockPath *string, nocache bool) (*Writer, error)

Create creates the file for the given path in nocache mode.

If nocache is set, the writer doesn't pollute OS page cache.

func OpenWriterAt

func OpenWriterAt(path string, lockPath *string, offset int64, nocache bool) (*Writer, error)

OpenWriterAt opens the file at path in nocache mode for writing at the given offset.

The file at path is created if it is missing.

If nocache is set, the writer doesn't pollute OS page cache.

func (*Writer) MustClose

func (w *Writer) MustClose()

MustClose syncs the underlying file to storage and then closes it.

func (*Writer) MustFlush

func (w *Writer) MustFlush(isSync bool)

MustFlush flushes all the buffered data to file.

if isSync is true, then the flushed data is fsynced to the underlying storage.

func (*Writer) Write

func (w *Writer) Write(p []byte) (int, error)

Write writes p to the underlying file.