zserio::BitStreamReader::ReaderContext Struct Reference

#include <BitStreamReader.h>

Collaboration diagram for zserio::BitStreamReader::ReaderContext:

Public Member Functions
	ReaderContext (Span< const uint8_t > readBuffer, size_t readBufferBitSize)
	~ReaderContext ()=default
	ReaderContext (const ReaderContext &)=delete
ReaderContext &	operator= (const ReaderContext &)=delete
	ReaderContext (const ReaderContext &&)=delete
ReaderContext &	operator= (const ReaderContext &&)=delete

Public Attributes
Span< const uint8_t >	buffer
const BitPosType	bufferBitSize
uintptr_t	cache
uint8_t	cacheNumBits
BitPosType	bitIndex

Detailed Description

Context of the reader defining its state.

Definition at line 30 of file BitStreamReader.h.

Constructor & Destructor Documentation

ReaderContext() [1/3]

zserio::BitStreamReader::ReaderContext::ReaderContext ( Span< const uint8_t >  readBuffer, size_t  readBufferBitSize  )

explicit

Constructor.

Parameters

readBuffer	Span to the buffer to read.
readBufferBitSize	Size of the buffer in bits.

Definition at line 358 of file BitStreamReader.cpp.

~ReaderContext()

zserio::BitStreamReader::ReaderContext::~ReaderContext ( )

default

Destructor.

ReaderContext() [2/3]

zserio::BitStreamReader::ReaderContext::ReaderContext ( const ReaderContext &  )

delete

Copying and moving is disallowed!

ReaderContext() [3/3]

zserio::BitStreamReader::ReaderContext::ReaderContext ( const ReaderContext &&  )

delete

Copying and moving is disallowed!

Member Function Documentation

operator=() [1/2]

ReaderContext& zserio::BitStreamReader::ReaderContext::operator= ( const ReaderContext &&  )

delete

Copying and moving is disallowed!

operator=() [2/2]

ReaderContext& zserio::BitStreamReader::ReaderContext::operator= ( const ReaderContext &  )

delete

Copying and moving is disallowed!

Member Data Documentation

bitIndex

BitPosType zserio::BitStreamReader::ReaderContext::bitIndex

Current bit index.

Definition at line 64 of file BitStreamReader.h.

buffer

Span<const uint8_t> zserio::BitStreamReader::ReaderContext::buffer

Buffer to read from.

Definition at line 58 of file BitStreamReader.h.

bufferBitSize

const BitPosType zserio::BitStreamReader::ReaderContext::bufferBitSize

Size of the buffer in bits.

Definition at line 59 of file BitStreamReader.h.

cache

uintptr_t zserio::BitStreamReader::ReaderContext::cache

Bit cache to optimize bit reading.

Definition at line 61 of file BitStreamReader.h.

cacheNumBits

uint8_t zserio::BitStreamReader::ReaderContext::cacheNumBits

Num bits available in the bit cache.

Definition at line 62 of file BitStreamReader.h.

---

The documentation for this struct was generated from the following files:

• zserio/BitStreamReader.h
• zserio/BitStreamReader.cpp