catz

Documentation

Index

• type Flat
  • func NewFlatWithRoot(root string) *Flat
  • func (f *Flat) Exists() bool
  • func (f *Flat) Joins(paths ...string) *Flat
  • func (f *Flat) MkdirAll() error
  • func (f *Flat) NewGZFileReader(name string) (*GZFileReader, error)
  • func (f *Flat) NewGZFileWriter(name string, config *GZFileWriterConfig) (*GZFileWriter, error)
  • func (f *Flat) Path() string
  • func (f *Flat) Stat() (os.FileInfo, error)
• type GZFileReader
  • func NewGZFileReader(path string) (*GZFileReader, error)
  • func (g *GZFileReader) Close() error
  • func (g *GZFileReader) LineCount() (int, error)
  • func (g *GZFileReader) MaybeClose()
  • func (g *GZFileReader) MustClose() error
  • func (g *GZFileReader) Path() string
  • func (g *GZFileReader) Read(p []byte) (int, error)
  • func (g *GZFileReader) Reader() *gzip.Reader
• type GZFileWriter
  • func NewGZFileWriter(path string, config *GZFileWriterConfig) (*GZFileWriter, error)
  • func (g *GZFileWriter) Close() error
  • func (g *GZFileWriter) CloseNoReply()
  • func (g *GZFileWriter) Path() string
  • func (g *GZFileWriter) TryClose() error
  • func (g *GZFileWriter) Write(p []byte) (int, error)
  • func (g *GZFileWriter) Writer() *gzip.Writer
• type GZFileWriterConfig
  • func DefaultGZFileWriterConfig() *GZFileWriterConfig

Types

type Flat

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

func NewFlatWithRoot

func NewFlatWithRoot(root string) *Flat

func (*Flat) Exists

func (f *Flat) Exists() bool

Exists returns true if the directory exists.

func (*Flat) Joins

func (f *Flat) Joins(paths ...string) *Flat

func (*Flat) MkdirAll

func (f *Flat) MkdirAll() error

func (*Flat) NewGZFileReader

func (f *Flat) NewGZFileReader(name string) (*GZFileReader, error)

func (*Flat) NewGZFileWriter

func (f *Flat) NewGZFileWriter(name string, config *GZFileWriterConfig) (*GZFileWriter, error)

func (*Flat) Path

func (f *Flat) Path() string

func (*Flat) Stat

func (f *Flat) Stat() (os.FileInfo, error)

type GZFileReader

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

func NewGZFileReader

func NewGZFileReader(path string) (*GZFileReader, error)

func (*GZFileReader) Close

func (g *GZFileReader) Close() error

Close satisfies the io.Closer interface. It closes the gzip reader and the file.

func (*GZFileReader) LineCount

func (g *GZFileReader) LineCount() (int, error)

func (*GZFileReader) MaybeClose

func (g *GZFileReader) MaybeClose()

func (*GZFileReader) MustClose

func (g *GZFileReader) MustClose() error

func (*GZFileReader) Path

func (g *GZFileReader) Path() string

func (*GZFileReader) Read

func (g *GZFileReader) Read(p []byte) (int, error)

Read satisfies the io.Reader interface.

func (*GZFileReader) Reader

func (g *GZFileReader) Reader() *gzip.Reader

Reader returns the gzip reader for the file.

type GZFileWriter

type GZFileWriter struct {
	GZFileWriterConfig
	// contains filtered or unexported fields
}

func NewGZFileWriter

func NewGZFileWriter(path string, config *GZFileWriterConfig) (*GZFileWriter, error)

func (*GZFileWriter) Close

func (g *GZFileWriter) Close() error

func (*GZFileWriter) CloseNoReply

func (g *GZFileWriter) CloseNoReply()

func (*GZFileWriter) Path

func (g *GZFileWriter) Path() string

func (*GZFileWriter) TryClose

func (g *GZFileWriter) TryClose() error

func (*GZFileWriter) Write

func (g *GZFileWriter) Write(p []byte) (int, error)

func (*GZFileWriter) Writer

func (g *GZFileWriter) Writer() *gzip.Writer

type GZFileWriterConfig

type GZFileWriterConfig struct {
	CompressionLevel int
	Flag             int
	FilePerm         os.FileMode
	DirPerm          os.FileMode
}

func DefaultGZFileWriterConfig

func DefaultGZFileWriterConfig() *GZFileWriterConfig