filestream

package

v1.110.21 Latest Latest Go to latest Published: Oct 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 22

Documentation ¶

Rendered for

Index ¶

type ParallelFileCreator
- func (pfc *ParallelFileCreator) Add(dstPath string, wc *WriteCloser, nocache bool)
- func (pfc *ParallelFileCreator) Run()
type ParallelFileOpener
- func (pfo *ParallelFileOpener) Add(path string, rc *ReadCloser, nocache bool)
- func (pfo *ParallelFileOpener) Run()
type ParallelStreamWriter
- func (psw *ParallelStreamWriter) Add(dstPath string, src io.WriterTo)
- func (psw *ParallelStreamWriter) Run()
type ReadCloser
type Reader
- func MustOpen(path string, nocache bool) *Reader
- func OpenReaderAt(path string, offset int64, nocache bool) (*Reader, error)
type WriteCloser
type Writer
- func MustCreate(path string, nocache bool) *Writer
- func OpenWriterAt(path string, offset int64, nocache bool) (*Writer, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ParallelFileCreator ¶ added in v1.110.15

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

ParallelFileCreator is used for parallel creating of files for the given dstPath.

ParallelFileCreator is needed for speeding up creating many files on high-latency storage systems such as NFS or Ceph.

func (*ParallelFileCreator) Add ¶ added in v1.110.15

func (pfc *ParallelFileCreator) Add(dstPath string, wc *WriteCloser, nocache bool)

Add registers a task for creating the file at dstPath and assigning it to *wc.

Tasks are executed in parallel on Run() call.

func (*ParallelFileCreator) Run ¶ added in v1.110.15

func (pfc *ParallelFileCreator) Run()

Run runs all the registered tasks for creating files in parallel.

type ParallelFileOpener ¶ added in v1.110.15

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

ParallelFileOpener is used for parallel opening of files at the given dstPath.

ParallelFileOpener is needed for speeding up opening many files on high-latency storage systems such as NFS or Ceph.

func (*ParallelFileOpener) Add ¶ added in v1.110.15

func (pfo *ParallelFileOpener) Add(path string, rc *ReadCloser, nocache bool)

Add registers a task for opening the file ath the given path and assigning it to *rc.

Tasks are executed in parallel on Run() call.

func (*ParallelFileOpener) Run ¶ added in v1.110.15

func (pfo *ParallelFileOpener) Run()

Run runs all the registered tasks for opening files in parallel.

type ParallelStreamWriter ¶ added in v1.110.15

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

ParallelStreamWriter is used for parallel writing of data from io.WriterTo to the given dstPath files.

ParallelStreamWriter is needed for speeding up writing data to many files on high-latency storage systems such as NFS or Ceph.

func (*ParallelStreamWriter) Add ¶ added in v1.110.15

func (psw *ParallelStreamWriter) Add(dstPath string, src io.WriterTo)

Add adds a task to execute in parallel - to write the data from src to the dstPath.

Tasks are executed in parallel on Run() call.

func (*ParallelStreamWriter) Run ¶ added in v1.110.15

func (psw *ParallelStreamWriter) Run()

Run executes all the tasks added via Add() call in parallel.

type ReadCloser ¶

type ReadCloser interface {
	Path() string
	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 MustOpen ¶ added in v1.91.0

func MustOpen(path string, nocache bool) *Reader

MustOpen 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 ¶ added in v1.29.0

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 MustOpen.

func (*Reader) Path ¶ added in v1.91.0

func (r *Reader) Path() string

Path returns the path to r

func (*Reader) Read ¶

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

Read reads file contents to p.

type WriteCloser ¶

type WriteCloser interface {
	Path() string
	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 MustCreate ¶ added in v1.91.0

func MustCreate(path string, nocache bool) *Writer

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

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

func OpenWriterAt ¶ added in v1.29.0

func OpenWriterAt(path 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 ¶ added in v1.34.0

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) Path ¶ added in v1.91.0

func (w *Writer) Path() string

Path returns the path to r

func (*Writer) Write ¶

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

Write writes p to the underlying file.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL