Package: github.com/pierrec/lz4/v4/internal/lz4stream

package lz4stream Import Path github.com/pierrec/lz4/v4/internal/lz4stream (on go.dev) Dependency Relation imports 8 packages, and imported by one package

Involved Source Files block.go d frame.go Package lz4stream provides the types that support reading and writing LZ4 data streams. frame_gen.go

Package-Level Type Names (total 6)

/* sort by: alphabet | popularity */

type Blocks (struct) Fields (total 2) Block *FrameDataBlock Blocks chan chan *FrameDataBlock Methods (only one) (*Blocks) ErrorR() error ErrorR returns any error set while uncompressing a stream.

type DataBlockSize uint32 (basic type) DataBlockSize is defined as follow: field bits ----- ---- size 31 Uncompressed 1 Methods (total 2) ( DataBlockSize) Uncompressed() bool (*DataBlockSize) UncompressedSet(v bool) *DataBlockSize As Outputs Of (at least one exported) func (*DataBlockSize).UncompressedSet(v bool) *DataBlockSize

type DescriptorFlags uint16 (basic type) DescriptorFlags is defined as follow: field bits ----- ---- _ 2 ContentChecksum 1 Size 1 BlockChecksum 1 BlockIndependence 1 Version 2 _ 4 BlockSizeIndex 3 _ 1 Methods (total 12) ( DescriptorFlags) BlockChecksum() bool (*DescriptorFlags) BlockChecksumSet(v bool) *DescriptorFlags ( DescriptorFlags) BlockIndependence() bool (*DescriptorFlags) BlockIndependenceSet(v bool) *DescriptorFlags ( DescriptorFlags) BlockSizeIndex() lz4block.BlockSizeIndex (*DescriptorFlags) BlockSizeIndexSet(v lz4block.BlockSizeIndex) *DescriptorFlags ( DescriptorFlags) ContentChecksum() bool Getters. (*DescriptorFlags) ContentChecksumSet(v bool) *DescriptorFlags Setters. ( DescriptorFlags) Size() bool (*DescriptorFlags) SizeSet(v bool) *DescriptorFlags ( DescriptorFlags) Version() uint16 (*DescriptorFlags) VersionSet(v uint16) *DescriptorFlags As Outputs Of (at least 6) func (*DescriptorFlags).BlockChecksumSet(v bool) *DescriptorFlags func (*DescriptorFlags).BlockIndependenceSet(v bool) *DescriptorFlags func (*DescriptorFlags).BlockSizeIndexSet(v lz4block.BlockSizeIndex) *DescriptorFlags func (*DescriptorFlags).ContentChecksumSet(v bool) *DescriptorFlags func (*DescriptorFlags).SizeSet(v bool) *DescriptorFlags func (*DescriptorFlags).VersionSet(v uint16) *DescriptorFlags

type Frame (struct) Fields (total 4) Blocks Blocks Checksum uint32 Descriptor FrameDescriptor Magic uint32 Methods (total 6) (*Frame) CloseR(src io.Reader) (err error) (*Frame) CloseW(dst io.Writer, num int) error (*Frame) InitR(src io.Reader, num int) (chan []byte, error) (*Frame) InitW(dst io.Writer, num int, legacy bool) (*Frame) ParseHeaders(src io.Reader) error (*Frame) Reset(num int) Reset allows reusing the Frame. The Descriptor configuration is not modified. As Outputs Of (at least one exported) func NewFrame() *Frame As Inputs Of (at least 7) func NewFrameDataBlock(f *Frame) *FrameDataBlock func (*FrameDataBlock).Close(f *Frame) func (*FrameDataBlock).Compress(f *Frame, src []byte, level lz4block.CompressionLevel) *FrameDataBlock func (*FrameDataBlock).Read(f *Frame, src io.Reader, cum uint32) (uint32, error) func (*FrameDataBlock).Uncompress(f *Frame, dst, dict []byte, sum bool) ([]byte, error) func (*FrameDataBlock).Write(f *Frame, dst io.Writer) error func (*FrameDescriptor).Write(f *Frame, dst io.Writer) error

type FrameDataBlock (struct) Fields (total 3) Checksum uint32 Data []byte // compressed or uncompressed data (.data or .src) Size DataBlockSize Methods (total 5) (*FrameDataBlock) Close(f *Frame) (*FrameDataBlock) Compress(f *Frame, src []byte, level lz4block.CompressionLevel) *FrameDataBlock Block compression errors are ignored since the buffer is sized appropriately. (*FrameDataBlock) Read(f *Frame, src io.Reader, cum uint32) (uint32, error) Read updates b with the next block data, size and checksum if available. (*FrameDataBlock) Uncompress(f *Frame, dst, dict []byte, sum bool) ([]byte, error) (*FrameDataBlock) Write(f *Frame, dst io.Writer) error As Outputs Of (at least 2) func NewFrameDataBlock(f *Frame) *FrameDataBlock func (*FrameDataBlock).Compress(f *Frame, src []byte, level lz4block.CompressionLevel) *FrameDataBlock

type FrameDescriptor (struct) Fields (total 3) Checksum uint8 ContentSize uint64 Flags DescriptorFlags Methods (only one) (*FrameDescriptor) Write(f *Frame, dst io.Writer) error

Package-Level Functions (total 2)

func NewFrame() *Frame

func NewFrameDataBlock(f *Frame) *FrameDataBlock