ebml::parseString Class Reference

Represents a parsed EBML string segment. More...

#include <string.h>

Classes
class	iterator
	Iterator for parseString objects. More...

Public Member Functions
	parseString ()
	parseString (const parseString &)
	parseString (parseString &&)
parseString &	operator= (const parseString &)
parseString &	operator= (parseString &&)
	parseString (const char *, size_t)
	Construct from a raw buffer. More...
	parseString (const char *, size_t, off_t)
	Construct from a raw buffer with an offset parameter. More...
	parseString (ebmlID_t, vintWidth_t, size_t, vintWidth_t, off_t, const char *)
	Main constructor that initializes all fields. More...
	parseString (const parseFile &, char *)
	Construct a parseString directly from a parseFile object. More...
parseString::iterator	begin () const
	Returns an iterator to the beginning of the contained EBML elements. More...
unsigned long long	outerSize () const
	Returns the outer size (header + data) of the element. More...
template<typename T >
T	unpack () const
	Template method to unpack data from the element's payload. More...

Public Attributes
ebmlID_t	ebmlID
vintWidth_t	ebmlIDWidth
size_t	dataSize
vintWidth_t	sizeWidth
off_t	offset
const char *	data
parseString *	parent

Detailed Description

Represents a parsed EBML string segment.

A parseString holds the parsed details for an EBML element extracted from a raw buffer. It stores the EBML ID, the widths used for encoding, the size of the data, and a pointer into the raw data. It may also reference a "parent" parseString for nested elements.

Public members:

• ebmlID: The numeric ID of the EBML element.
• ebmlIDWidth: The number of bytes used to store the EBML ID.
• dataSize: The size (in bytes) of the element’s data.
• sizeWidth: The number of bytes used to store the data size.
• offset: The offset (relative to the parent element’s data) of this element.
• data: Pointer to the start of the element’s data.
• parent: Pointer to a parent parseString (if any).

It also defines an iterator for sequential parsing of nested EBML elements.

Note

The class provides a template member function unpack<T>() that uses the externally defined function ebml::unpack<T>().

Constructor & Destructor Documentation

parseString() [1/7]

ebml::parseString::parseString

(

)

parseString() [2/7]

ebml::parseString::parseString

(

const parseString &

other

)

parseString() [3/7]

ebml::parseString::parseString

(

parseString &&

other

)

parseString() [4/7]

ebml::parseString::parseString	(	const char *	data,
		size_t	size
	)

Construct from a raw buffer.

Parameters

data	Pointer to raw data containing EBML element.
size	Total number of bytes available in the data.

parseString() [5/7]

ebml::parseString::parseString	(	const char *	data,
		size_t	size,
		off_t	offset
	)

Construct from a raw buffer with an offset parameter.

Parameters

data	Pointer to raw data.
size	Total size in bytes.
offset	Offset relative to the parent element.

parseString() [6/7]

ebml::parseString::parseString	(	ebmlID_t	,
		vintWidth_t	,
		size_t	,
		vintWidth_t	,
		off_t	,
		const char *
	)

Main constructor that initializes all fields.

Parameters

ebmlID	The EBML ID.
ebmlIDWidth	Number of bytes used to encode ebmlID.
dataSize	Size of the element data in bytes.
sizeWidth	Number of bytes used to encode dataSize.
offset	Offset relative to the containing parent's data.
data	Pointer to the actual element data.

parseString() [7/7]

ebml::parseString::parseString	(	const parseFile &	parsed,
		char *	buffer
	)

Construct a parseString directly from a parseFile object.

Parameters

parsed	A parseFile object.
buffer	A character buffer to hold the data.

Member Function Documentation

begin()

parseString::iterator ebml::parseString::begin

(

)

const

Returns an iterator to the beginning of the contained EBML elements.

This iterator walks through the child elements contained in the data.

Returns

An iterator for this parseString.

operator=() [1/2]

parseString & ebml::parseString::operator=

(

const parseString &

other

)

operator=() [2/2]

parseString & ebml::parseString::operator=

(

parseString &&

other

)

outerSize()

unsigned long long ebml::parseString::outerSize

(

)

const

Returns the outer size (header + data) of the element.

Returns

Total size in bytes of the element including EBML ID and size fields.

unpack()

template<typename T >

T ebml::parseString::unpack ( ) const

inline

Template method to unpack data from the element's payload.

This function calls the global function ebml::unpack<T>() on the element's data.

Template Parameters

T	The target type to unpack.

Returns

The unpacked value of type T.

Member Data Documentation

data

const char* ebml::parseString::data

Pointer to the beginning of the element data.

dataSize

size_t ebml::parseString::dataSize

The size (in bytes) of the element data.

ebmlID

ebmlID_t ebml::parseString::ebmlID

The EBML ID for the element.

ebmlIDWidth

vintWidth_t ebml::parseString::ebmlIDWidth

The width (in bytes) of the EBML ID.

offset

off_t ebml::parseString::offset

Offset relative to start of parent data.

parent

parseString* ebml::parseString::parent

Pointer to the parent parseString (if any).

sizeWidth

vintWidth_t ebml::parseString::sizeWidth

The width (in bytes) of the size field.

---

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

• src/libebml_ng/parsing/string.h
• src/libebml_ng/parsing/string.cpp