class ZStdReader

Declaration

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

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

Inherits from: ICompressedReader

Method Overview

  • public static mcap::Status DecompressAll(const int * data, uint64_t compressedSize, uint64_t uncompressedSize, int * output)
  • public ZStdReader()
  • public ZStdReader(const mcap::ZStdReader &)
  • public ZStdReader(mcap::ZStdReader &&)
  • 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

Inherited from ICompressedReader:

Inherited from IReadable:

Methods

static mcap::Status DecompressAll(
    const int* data,
    uint64_t compressedSize,
    uint64_t uncompressedSize,
    int* output)

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

Parameters

const int* data
uint64_t compressedSize
uint64_t uncompressedSize
int* output

ZStdReader()

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

ZStdReader(const mcap::ZStdReader&)

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

Parameters

const mcap::ZStdReader& 

ZStdReader(mcap::ZStdReader&&)

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

Parameters

mcap::ZStdReader&& 

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

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

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:160

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:162

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:163