class LZ4Reader

Declaration

class LZ4Reader : public ICompressedReader { /* full declaration omitted */ };

Declared at: mcap/include/mcap/reader.hpp:194

Inherits from: ICompressedReader

Method Overview

  • public LZ4Reader()
  • public LZ4Reader(const mcap::LZ4Reader &)
  • public LZ4Reader(mcap::LZ4Reader &&)
  • public mcap::Status decompressAll(const int * data, uint64_t size, uint64_t uncompressedSize, int * output)
  • public uint64_t read(int ** output, uint64_t offset, uint64_t size)
  • public void reset(const int * data, uint64_t size, uint64_t uncompressedSize)
  • public uint64_t size() const
  • public mcap::Status status() const
  • public ~LZ4Reader()

Inherited from ICompressedReader:

Inherited from IReadable:

Methods

LZ4Reader()

Declared at: mcap/include/mcap/reader.hpp:213

LZ4Reader(const mcap::LZ4Reader&)

Declared at: mcap/include/mcap/reader.hpp:214

Parameters

const mcap::LZ4Reader& 

LZ4Reader(mcap::LZ4Reader&&)

Declared at: mcap/include/mcap/reader.hpp:216

Parameters

mcap::LZ4Reader&& 

mcap::Status decompressAll(
    const int* data,
    uint64_t size,
    uint64_t uncompressedSize,
    int* output)

Declared at: mcap/include/mcap/reader.hpp:211

Parameters

const int* data
uint64_t size
uint64_t uncompressedSize
int* output

uint64_t read(int** output,
              uint64_t offset,
              uint64_t size)

Declared at: mcap/include/mcap/reader.hpp:197

Parameters

int** output
uint64_t offset
uint64_t size

void reset(const int* data,
           uint64_t size,
           uint64_t uncompressedSize)

Declared at: mcap/include/mcap/reader.hpp:196

Parameters

const int* data
uint64_t size
uint64_t uncompressedSize

uint64_t size() const

Description

Returns the size of the file in bytes.

Declared at: mcap/include/mcap/reader.hpp:198

Returns

uint64_t The total number of bytes in the MCAP file.

mcap::Status status() const

Description

Report the current status of decompression. A StatusCode other than `StatusCode::Success` after `reset()` is called indicates the decompression was not successful and the reader is in an invalid state.

Declared at: mcap/include/mcap/reader.hpp:199

~LZ4Reader()

Declared at: mcap/include/mcap/reader.hpp:218