mcap

package module

Go to main page

Versions in this module

v1

v1.4.0

May 14, 2024

Changes in this version

type Message

+ func (m *Message) PopulateFrom(buf []byte, copyData bool) error

type MessageIterator

+ NextInto func(msg *Message) (*Schema, *Channel, *Message, error)

v1.3.1

Apr 30, 2024

Changes in this version

type ErrBadMagic

+ func (e *ErrBadMagic) Is(err error) bool

v1.3.0

Mar 8, 2024

Changes in this version

type ReadOpt

+ func AfterNanos(start uint64) ReadOpt

+ func BeforeNanos(end uint64) ReadOpt

type ReadOptions

+ EndNanos uint64

+ StartNanos uint64

+ func (ro *ReadOptions) Finalize()

v1.2.0

Feb 13, 2024

v1.1.1

Jan 23, 2024

v1.1.0

Nov 3, 2023

Changes in this version

+ var ErrMetadataNotFound = errors.New("metadata not found")

+ type ReadOpt func(*ReadOptions) error

+ func After(start int64) ReadOpt

+ func Before(end int64) ReadOpt

+ func InOrder(order ReadOrder) ReadOpt

+ func UsingIndex(useIndex bool) ReadOpt

+ func WithMetadataCallback(callback func(*Metadata) error) ReadOpt

+ func WithTopics(topics []string) ReadOpt

+ type ReadOptions struct

+ End int64

+ MetadataCallback func(*Metadata) error

+ Order ReadOrder

+ Start int64

+ Topics []string

+ UseIndex bool

+ type ReadOrder int

+ const FileOrder

+ const LogTimeOrder

+ const ReverseLogTimeOrder

type Reader

+ func (r *Reader) GetAttachmentReader(offset uint64) (*AttachmentReader, error)

+ func (r *Reader) GetMetadata(offset uint64) (*Metadata, error)

v1.0.4

Sep 12, 2023

Changes in this version

+ type CustomCompressor interface

+ Compression func() CompressionFormat

+ Compressor func() ResettableWriteCloser

+ func NewCustomCompressor(compression CompressionFormat, compressor ResettableWriteCloser) CustomCompressor

type LexerOptions

+ Decompressors map[CompressionFormat]ResettableReader

+ type ResettableReader interface

+ Reset func(io.Reader) error

+ type ResettableWriteCloser interface

+ Reset func(io.Writer)

type WriterOptions

+ Compressor CustomCompressor

v1.0.3

Aug 24, 2023

v1.0.2

Aug 24, 2023

Changes in this version

type Info

+ Footer *Footer

type Writer

+ func (w *Writer) WriteChunkIndex(idx *ChunkIndex) error

type WriterOptions

+ SkipMagic bool

v1.0.1

Mar 30, 2023

Changes in this version

+ var ErrInvalidZeroOpcode = errors.New("invalid zero opcode")

+ type CompressionLevel int

+ const CompressionLevelBest

+ const CompressionLevelBetter

+ const CompressionLevelDefault

+ const CompressionLevelFastest

type MessageIndex

+ func (idx *MessageIndex) IsEmpty() bool

type WriterOptions

+ CompressionLevel CompressionLevel

v1.0.0

Feb 7, 2023

v0

v0.4.0

Dec 19, 2022

Changes in this version

type Lexer

+ func (l *Lexer) Close()

type Reader

+ func (r *Reader) Close()

v0.3.0

Nov 21, 2022

Changes in this version

+ var ErrAttachmentDataSizeIncorrect = errors.New("attachment content length incorrect")

type Attachment

+ DataSize uint64

+ type AttachmentReader struct

+ CreateTime uint64

+ DataSize uint64

+ LogTime uint64

+ MediaType string

+ Name string

+ func (ar *AttachmentReader) ComputedCRC() (uint32, error)

+ func (ar *AttachmentReader) Data() io.Reader

+ func (ar *AttachmentReader) ParsedCRC() (uint32, error)

type ErrBadMagic

+ func (e *ErrBadMagic) Error() string

+ type ErrTruncatedRecord struct

+ func (e *ErrTruncatedRecord) Error() string

+ func (e *ErrTruncatedRecord) Unwrap() error

type LexerOptions

+ AttachmentCallback func(*AttachmentReader) error

+ ComputeAttachmentCRCs bool

+ ValidateChunkCRCs bool

v0.2.0

Nov 2, 2022

Changes in this version

type Reader

+ func (r *Reader) Header() *Header

v0.1.2

Oct 16, 2022

v0.1.1

Oct 13, 2022

Changes in this version

+ var Version = "v0.1.1"

v0.1.0

Oct 11, 2022

Changes in this version

+ var ErrBadMagic = errors.New("not an MCAP file")

+ var ErrChunkTooLarge = errors.New("chunk exceeds configured maximum size")

+ var ErrLengthOutOfRange = errors.New("length out of int32 range")

+ var ErrNestedChunk = errors.New("detected nested chunk")

+ var ErrRecordTooLarge = errors.New("record exceeds configured maximum size")

+ var ErrUnknownSchema = errors.New("unknown schema")

+ var Magic = []byte

+ func Range(it MessageIterator, f func(*Schema, *Channel, *Message) error) error

+ type Attachment struct

+ CRC uint32

+ CreateTime uint64

+ Data []byte

+ LogTime uint64

+ MediaType string

+ Name string

+ func ParseAttachment(buf []byte) (*Attachment, error)

+ type AttachmentIndex struct

+ CreateTime uint64

+ DataSize uint64

+ Length uint64

+ LogTime uint64

+ MediaType string

+ Name string

+ Offset uint64

+ func ParseAttachmentIndex(buf []byte) (*AttachmentIndex, error)

+ type Channel struct

+ ID uint16

+ MessageEncoding string

+ Metadata map[string]string

+ SchemaID uint16

+ Topic string

+ func ParseChannel(buf []byte) (*Channel, error)

+ type Chunk struct

+ Compression string

+ MessageEndTime uint64

+ MessageStartTime uint64

+ Records []byte

+ UncompressedCRC uint32

+ UncompressedSize uint64

+ func ParseChunk(buf []byte) (*Chunk, error)

+ type ChunkIndex struct

+ ChunkLength uint64

+ ChunkStartOffset uint64

+ CompressedSize uint64

+ Compression CompressionFormat

+ MessageEndTime uint64

+ MessageIndexLength uint64

+ MessageIndexOffsets map[uint16]uint64

+ MessageStartTime uint64

+ UncompressedSize uint64

+ func ParseChunkIndex(buf []byte) (*ChunkIndex, error)

+ type CompressionFormat string

+ const CompressionLZ4

+ const CompressionNone

+ const CompressionZSTD

+ func (c CompressionFormat) String() string

+ type DataEnd struct

+ DataSectionCRC uint32

+ func ParseDataEnd(buf []byte) (*DataEnd, error)

+ type Footer struct

+ SummaryCRC uint32

+ SummaryOffsetStart uint64

+ SummaryStart uint64

+ func ParseFooter(buf []byte) (*Footer, error)

+ type Header struct

+ Library string

+ Profile string

+ func ParseHeader(buf []byte) (*Header, error)

+ type Info struct

+ AttachmentIndexes []*AttachmentIndex

+ Channels map[uint16]*Channel

+ ChunkIndexes []*ChunkIndex

+ Header *Header

+ MetadataIndexes []*MetadataIndex

+ Schemas map[uint16]*Schema

+ Statistics *Statistics

+ func (i *Info) ChannelCounts() map[string]uint64

+ type Lexer struct

+ func NewLexer(r io.Reader, opts ...*LexerOptions) (*Lexer, error)

+ func (l *Lexer) Next(p []byte) (TokenType, []byte, error)

+ type LexerOptions struct

+ EmitChunks bool

+ EmitInvalidChunks bool

+ MaxDecompressedChunkSize int

+ MaxRecordSize int

+ SkipMagic bool

+ ValidateCRC bool

+ type Message struct

+ ChannelID uint16

+ Data []byte

+ LogTime uint64

+ PublishTime uint64

+ Sequence uint32

+ func ParseMessage(buf []byte) (*Message, error)

+ type MessageIndex struct

+ ChannelID uint16

+ Records []MessageIndexEntry

+ func ParseMessageIndex(buf []byte) (*MessageIndex, error)

+ func (idx *MessageIndex) Add(timestamp uint64, offset uint64)

+ func (idx *MessageIndex) Entries() []MessageIndexEntry

+ func (idx *MessageIndex) Insort()

+ func (idx *MessageIndex) Reset()

+ type MessageIndexEntry struct

+ Offset uint64

+ Timestamp uint64

+ type MessageIterator interface

+ Next func([]byte) (*Schema, *Channel, *Message, error)

+ type Metadata struct

+ Metadata map[string]string

+ Name string

+ func ParseMetadata(buf []byte) (*Metadata, error)

+ type MetadataIndex struct

+ Length uint64

+ Name string

+ Offset uint64

+ func ParseMetadataIndex(buf []byte) (*MetadataIndex, error)

+ type OpCode byte

+ const OpAttachment

+ const OpAttachmentIndex

+ const OpChannel

+ const OpChunk

+ const OpChunkIndex

+ const OpDataEnd

+ const OpFooter

+ const OpHeader

+ const OpMessage

+ const OpMessageIndex

+ const OpMetadata

+ const OpMetadataIndex

+ const OpReserved

+ const OpSchema

+ const OpStatistics

+ const OpSummaryOffset

+ func (c OpCode) String() string

+ type Reader struct

+ func NewReader(r io.Reader) (*Reader, error)

+ func (r *Reader) Info() (*Info, error)

+ func (r *Reader) Messages(opts ...readopts.ReadOpt) (MessageIterator, error)

+ type Schema struct

+ Data []byte

+ Encoding string

+ ID uint16

+ Name string

+ func ParseSchema(buf []byte) (*Schema, error)

+ type Statistics struct

+ AttachmentCount uint32

+ ChannelCount uint32

+ ChannelMessageCounts map[uint16]uint64

+ ChunkCount uint32

+ MessageCount uint64

+ MessageEndTime uint64

+ MessageStartTime uint64

+ MetadataCount uint32

+ SchemaCount uint16

+ func ParseStatistics(buf []byte) (*Statistics, error)

+ type SummaryOffset struct

+ GroupLength uint64

+ GroupOpcode OpCode

+ GroupStart uint64

+ func ParseSummaryOffset(buf []byte) (*SummaryOffset, error)

+ type TokenType int

+ const TokenAttachment

+ const TokenAttachmentIndex

+ const TokenChannel

+ const TokenChunk

+ const TokenChunkIndex

+ const TokenDataEnd

+ const TokenError

+ const TokenFooter

+ const TokenHeader

+ const TokenInvalidChunk

+ const TokenMessage

+ const TokenMessageIndex

+ const TokenMetadata

+ const TokenMetadataIndex

+ const TokenSchema

+ const TokenStatistics

+ const TokenSummaryOffset

+ func (t TokenType) String() string

+ type Writer struct

+ AttachmentIndexes []*AttachmentIndex

+ ChunkIndexes []*ChunkIndex

+ MetadataIndexes []*MetadataIndex

+ Statistics *Statistics

+ func NewWriter(w io.Writer, opts *WriterOptions) (*Writer, error)

+ func (w *Writer) Close() error

+ func (w *Writer) Offset() uint64

+ func (w *Writer) WriteAttachment(a *Attachment) error

+ func (w *Writer) WriteAttachmentIndex(idx *AttachmentIndex) error

+ func (w *Writer) WriteChannel(c *Channel) error

+ func (w *Writer) WriteDataEnd(e *DataEnd) error

+ func (w *Writer) WriteFooter(f *Footer) error

+ func (w *Writer) WriteHeader(header *Header) error

+ func (w *Writer) WriteMessage(m *Message) error

+ func (w *Writer) WriteMessageIndex(idx *MessageIndex) error

+ func (w *Writer) WriteMetadata(m *Metadata) error

+ func (w *Writer) WriteMetadataIndex(idx *MetadataIndex) error

+ func (w *Writer) WriteSchema(s *Schema) (err error)

+ func (w *Writer) WriteStatistics(s *Statistics) error

+ func (w *Writer) WriteSummaryOffset(s *SummaryOffset) error

+ type WriterOptions struct

+ ChunkSize int64

+ Chunked bool

+ Compression CompressionFormat

+ IncludeCRC bool

+ OverrideLibrary bool

+ SkipAttachmentIndex bool

+ SkipChunkIndex bool

+ SkipMessageIndexing bool

+ SkipMetadataIndex bool

+ SkipRepeatedChannelInfos bool

+ SkipRepeatedSchemas bool

+ SkipStatistics bool

+ SkipSummaryOffsets bool

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