singleapp

Documentation

Index

• Constants
• Variables
• type AppendableFile
  • func Open(fileName string, opts *Options) (*AppendableFile, error)
  • func (aof *AppendableFile) Append(bs []byte) (off int64, n int, err error)
  • func (aof *AppendableFile) Close() error
  • func (aof *AppendableFile) CompressionFormat() int
  • func (aof *AppendableFile) CompressionLevel() int
  • func (aof *AppendableFile) Copy(dstPath string) error
  • func (aof *AppendableFile) DiscardUpto(off int64) error
  • func (aof *AppendableFile) Flush() error
  • func (aof *AppendableFile) Metadata() []byte
  • func (aof *AppendableFile) Offset() int64
  • func (aof *AppendableFile) ReadAt(bs []byte, off int64) (n int, err error)
  • func (aof *AppendableFile) SetOffset(newOffset int64) error
  • func (aof *AppendableFile) Size() (int64, error)
  • func (aof *AppendableFile) SwitchToReadOnlyMode() error
  • func (aof *AppendableFile) Sync() error
• type Options
  • func DefaultOptions() *Options
  • func (opts *Options) GetCompressionFormat() int
  • func (opts *Options) GetCompressionLevel() int
  • func (opts *Options) GetPreallocSize() int
  • func (opts *Options) GetReadBufferSize() int
  • func (opts *Options) GetWriteBuffer() []byte
  • func (opts *Options) Validate() error
  • func (opts *Options) WithAutoSync(autoSync bool) *Options
  • func (opts *Options) WithCompresionLevel(compressionLevel int) *Options
  • func (opts *Options) WithCompressionFormat(compressionFormat int) *Options
  • func (opts *Options) WithCreateIfNotExists(createIfNotExists bool) *Options
  • func (opts *Options) WithFileMode(fileMode os.FileMode) *Options
  • func (opts *Options) WithMetadata(metadata []byte) *Options
  • func (opts *Options) WithPreallocSize(preallocSize int) *Options
  • func (opts *Options) WithReadBufferSize(size int) *Options
  • func (opts *Options) WithReadOnly(readOnly bool) *Options
  • func (opts *Options) WithRetryableSync(retryableSync bool) *Options
  • func (opts *Options) WithWriteBuffer(b []byte) *Options

Constants

const DefaultCompressionFormat = appendable.DefaultCompressionFormat

const DefaultCompressionLevel = appendable.DefaultCompressionLevel

const DefaultFileMode = os.FileMode(0644)

const DefaultReadBufferSize = 4096

const DefaultWriteBufferSize = 4096

Variables

var ErrAlreadyClosed = errors.New("singleapp: already closed")

var ErrBufferFull = errors.New("singleapp: buffer full")

var ErrCorruptedMetadata = errors.New("singleapp: corrupted metadata")

var ErrIllegalArguments = errors.New("singleapp: illegal arguments")

var ErrInvalidOptions = fmt.Errorf("%w: invalid options", ErrIllegalArguments)

var ErrNegativeOffset = errors.New("singleapp: negative offset")

var ErrReadOnly = errors.New("singleapp: read-only mode")

var ErrorPathIsNotADirectory = errors.New("singleapp: path is not a directory")

Types

type AppendableFile

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

func Open

func Open(fileName string, opts *Options) (*AppendableFile, error)

func (*AppendableFile) Append

func (aof *AppendableFile) Append(bs []byte) (off int64, n int, err error)

func (*AppendableFile) Close

func (aof *AppendableFile) Close() error

func (*AppendableFile) CompressionFormat

func (aof *AppendableFile) CompressionFormat() int

func (*AppendableFile) CompressionLevel

func (aof *AppendableFile) CompressionLevel() int

func (*AppendableFile) Copy

func (aof *AppendableFile) Copy(dstPath string) error

func (*AppendableFile) DiscardUpto

func (aof *AppendableFile) DiscardUpto(off int64) error

func (*AppendableFile) Flush

func (aof *AppendableFile) Flush() error

func (*AppendableFile) Metadata

func (aof *AppendableFile) Metadata() []byte

func (*AppendableFile) Offset

func (aof *AppendableFile) Offset() int64

func (*AppendableFile) ReadAt

func (aof *AppendableFile) ReadAt(bs []byte, off int64) (n int, err error)

func (*AppendableFile) SetOffset

func (aof *AppendableFile) SetOffset(newOffset int64) error

func (*AppendableFile) Size

func (aof *AppendableFile) Size() (int64, error)

func (*AppendableFile) SwitchToReadOnlyMode

func (aof *AppendableFile) SwitchToReadOnlyMode() error

func (*AppendableFile) Sync

func (aof *AppendableFile) Sync() error

type Options

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

func DefaultOptions

func DefaultOptions() *Options

func (*Options) GetCompressionFormat

func (opts *Options) GetCompressionFormat() int

func (*Options) GetCompressionLevel

func (opts *Options) GetCompressionLevel() int

func (*Options) GetPreallocSize

func (opts *Options) GetPreallocSize() int

func (*Options) GetReadBufferSize

func (opts *Options) GetReadBufferSize() int

func (*Options) GetWriteBuffer

func (opts *Options) GetWriteBuffer() []byte

func (*Options) Validate

func (opts *Options) Validate() error

func (*Options) WithAutoSync

func (opts *Options) WithAutoSync(autoSync bool) *Options

func (*Options) WithCompresionLevel

func (opts *Options) WithCompresionLevel(compressionLevel int) *Options

func (*Options) WithCompressionFormat

func (opts *Options) WithCompressionFormat(compressionFormat int) *Options

func (*Options) WithCreateIfNotExists

func (opts *Options) WithCreateIfNotExists(createIfNotExists bool) *Options

func (*Options) WithFileMode

func (opts *Options) WithFileMode(fileMode os.FileMode) *Options

func (*Options) WithMetadata

func (opts *Options) WithMetadata(metadata []byte) *Options

func (*Options) WithPreallocSize

func (opts *Options) WithPreallocSize(preallocSize int) *Options

func (*Options) WithReadBufferSize

func (opts *Options) WithReadBufferSize(size int) *Options

func (*Options) WithReadOnly

func (opts *Options) WithReadOnly(readOnly bool) *Options

func (*Options) WithRetryableSync

func (opts *Options) WithRetryableSync(retryableSync bool) *Options

func (*Options) WithWriteBuffer

func (opts *Options) WithWriteBuffer(b []byte) *Options