Represents a structure-like EBML master element. More...

#include <ebmlStruct.h>

Inheritance diagram for ebml::ebmlStructType:

Public Member Functions
	ebmlStructType (const char *, const std::wstring &, const slotSpec_l &)

	ebmlStructType (ebmlID_t, const std::wstring &, const slotSpec_l &)

	ebmlStructType (const char , const std::wstring &, const slotSpec_l &, const seekHelper_t seekHelper)

	ebmlStructType (ebmlID_t, const std::wstring &, const slotSpec_l &, const seekHelper_t *seekHelper)

const std::vector< slotSpec_t > &	slotSpecs () const

const std::unordered_map< std::string, const slotSpec_t * > &	slotSpecsByKey () const

const std::unordered_map< ebmlID_t, const slotSpec_t * > &	slotSpecsByID () const

const ebmlElementType *	typeBySlot (const std::string &) const

const ebmlElementType *	typeBySlot (size_t) const

Public Member Functions inherited from ebml::ebmlTypeCRTP< ebmlStructType, ebmlStruct, ebmlMasterElementType >
	ebmlTypeCRTP (Args &&... args)

ebml::ptr< ebmlStruct >	operator() (Args &&... args) const
	Creates a new instance of an EBML element. More...

ebml::ptr< ebmlStruct >	decode (const parseString &parsed) const

ebml::ptr< ebmlStruct >	decode (const parseFile &parsed) const

ebml::ptr< ebmlStruct >	decode (const char *data, size_t size) const

ebml::ptr< ebmlStruct >	decode (const std::string &data) const

ebml::ptr< ebmlStruct >	decode (ioBase &file) const

ebml::ptr< ebmlStruct >	decode (ioBase &file, off_t &offset) const

ebml::ptr< ebmlStruct >	decode (ioBase &file, off_t offset, off_t &endoffset) const

ebml::ptr< const ebmlStruct >	cdecode (const parseString &parsed) const

ebml::ptr< const ebmlStruct >	cdecode (const parseFile &parsed) const

ebml::ptr< const ebmlStruct >	cdecode (const char *data, size_t size) const

ebml::ptr< const ebmlStruct >	cdecode (const std::string &data) const

ebml::ptr< const ebmlStruct >	cdecode (ioBase &file) const

ebml::ptr< const ebmlStruct >	cdecode (ioBase &file, off_t &offset) const

ebml::ptr< const ebmlStruct >	cdecode (ioBase &file, off_t offset, off_t &endoffset) const

Public Member Functions inherited from ebml::ebmlMasterElementType
	ebmlMasterElementType (const char *, const std::wstring &, const childTypeSpecArg_l &)

	ebmlMasterElementType (ebmlID_t, const std::wstring &, const childTypeSpecArg_l &)

	ebmlMasterElementType (const char , const std::wstring &, const childTypeSpecArg_l &, const seekHelper_t seekHelper)

	ebmlMasterElementType (ebmlID_t, const std::wstring &, const childTypeSpecArg_l &, const seekHelper_t *seekHelper)

const childTypeSpec_t &	childTypes () const
	Gets the child type specification. More...

Public Member Functions inherited from ebml::ebmlTypeCRTP< ebmlMasterElementType, ebmlMasterElement >
	ebmlTypeCRTP (Args &&... args)

ebml::ptr< ebmlMasterElement >	operator() (Args &&... args) const
	Creates a new instance of an EBML element. More...

ebml::ptr< ebmlMasterElement >	decode (const parseString &parsed) const

ebml::ptr< ebmlMasterElement >	decode (const parseFile &parsed) const

ebml::ptr< ebmlMasterElement >	decode (const char *data, size_t size) const

ebml::ptr< ebmlMasterElement >	decode (const std::string &data) const

ebml::ptr< ebmlMasterElement >	decode (ioBase &file) const

ebml::ptr< ebmlMasterElement >	decode (ioBase &file, off_t &offset) const

ebml::ptr< ebmlMasterElement >	decode (ioBase &file, off_t offset, off_t &endoffset) const

ebml::ptr< const ebmlMasterElement >	cdecode (const parseString &parsed) const

ebml::ptr< const ebmlMasterElement >	cdecode (const parseFile &parsed) const

ebml::ptr< const ebmlMasterElement >	cdecode (const char *data, size_t size) const

ebml::ptr< const ebmlMasterElement >	cdecode (const std::string &data) const

ebml::ptr< const ebmlMasterElement >	cdecode (ioBase &file) const

ebml::ptr< const ebmlMasterElement >	cdecode (ioBase &file, off_t &offset) const

ebml::ptr< const ebmlMasterElement >	cdecode (ioBase &file, off_t offset, off_t &endoffset) const

Public Member Functions inherited from ebml::ebmlElementType
	ebmlElementType (const char *ebmlID, const std::wstring &name)
	Constructor taking an EBML ID as a VINT string and an element name. More...

	ebmlElementType (const char ebmlID, const std::wstring &name, const seekHelper_t seekHelper)

	ebmlElementType (ebmlID_t ebmlID, const std::wstring &name)
	Constructor taking an EBML ID as an unsigned integer and an element name. More...

	ebmlElementType (ebmlID_t ebmlID, const std::wstring &name, const seekHelper_t *seekHelper)

ebml::ptr< ebmlElement >	operator() () const
	Factory operator to create a default EBML element instance. More...

seekMapBase *	initSeekMap () const

seekData_t *	makeSeekData (const parseString &) const

seekData_t *	makeSeekData (const parseString &, const ebmlMasterElement_wp &) const

seekData_t *	makeSeekData (const parseString &, ebmlMasterElement_wp &&) const

seekData_t *	makeSeekData (const parseFile &) const

seekData_t *	makeSeekData (const parseFile &, const ebmlMasterElement_wp &) const

seekData_t *	makeSeekData (const parseFile &, ebmlMasterElement_wp &&) const

template<typename T = ebmlElementType>
T &	as ()

template<typename T = ebmlElementType>
T &	as () const

virtual std::wstring	minirepr () const

std::wstring	repr () const

ebml::ptr< ebmlElement >	decode (const parseString &) const
	Decode element from `ebml::parseString` instance. More...

ebml::ptr< ebmlElement >	decode (const parseFile &) const
	Decode and create a new EBML element instance from `ebml::parseFile` instance. More...

ebml::ptr< ebmlElement >	decode (const char *, size_t) const
	Decode and create a new EBML element instance from a raw data buffer. More...

ebml::ptr< ebmlElement >	decode (const std::string &) const
	Decode and create a new EBML element instance from a `std::string` instance. More...

ebml::ptr< ebmlElement >	decode (ioBase &) const
	Decode and create a new EBML element instance from `ebml::ioBase` instance at the current file position. More...

ebml::ptr< ebmlElement >	decode (ioBase &, off_t &) const
	Decode and create a new EBML element instance from `ebml::ioBase` instance with a specified offset. More...

ebml::ptr< ebmlElement >	decode (ioBase &, off_t, off_t &) const
	Decode from `ebml::ioBase` instance with a specified offset and store the end offset. More...

ebml::ptr< const ebmlElement >	cdecode (const parseString &) const

ebml::ptr< const ebmlElement >	cdecode (const parseFile &) const

ebml::ptr< const ebmlElement >	cdecode (const char *, size_t) const

ebml::ptr< const ebmlElement >	cdecode (const std::string &) const

ebml::ptr< const ebmlElement >	cdecode (ioBase &) const

ebml::ptr< const ebmlElement >	cdecode (ioBase &, off_t &offset) const

ebml::ptr< const ebmlElement >	cdecode (ioBase &, off_t offset, off_t &end) const

Friends
class	ebmlStruct

Additional Inherited Members
Public Attributes inherited from ebml::ebmlElementType
ebmlID_t	ebmlID
	EBML ID associated with this element type. More...

std::wstring	name
	Name (as a wide string) of the element type. More...

const seekHelper_t *	_seekHelper = &seekHelper

Protected Member Functions inherited from ebml::ebmlTypeCRTP< ebmlStructType, ebmlStruct, ebmlMasterElementType >
ebmlElement *	_new () const

ebmlElement *	_decode_v (const parseString &) const

ebmlElement *	_decode_v (const parseFile &) const

ebmlElement *	_cdecode_v (const parseString &) const

ebmlElement *	_cdecode_v (const parseFile &) const

Protected Member Functions inherited from ebml::ebmlMasterElementType
	ebmlMasterElementType (const char *, const std::wstring &)

	ebmlMasterElementType (ebmlID_t, const std::wstring &)

	ebmlMasterElementType (const char , const std::wstring &, const seekHelper_t seekHelper)

	ebmlMasterElementType (ebmlID_t, const std::wstring &, const seekHelper_t *seekHelper)

ebmlElement *	_decodeChild (const parseString &) const

ebmlElement *	_decodeChild (const parseFile &) const

ebmlElement *	_cdecodeChild (const parseString &) const

ebmlElement *	_cdecodeChild (const parseFile &) const

Protected Member Functions inherited from ebml::ebmlElementType
ebmlElement *	_decode_nocheck (const parseString &parsed) const
	Decode element from `ebml::parseString` instance. More...

ebmlElement *	_decode_nocheck (const parseFile &parsed) const
	Decode element from `ebml::parseFile` instance. More...

ebmlElement *	_cdecode_nocheck (const parseString &parsed) const

ebmlElement *	_cdecode_nocheck (const parseFile &parsed) const

ebmlElement *	_decode (const parseString &) const
	Decode element from `ebml::parseString` instance. More...

ebmlElement *	_decode (const parseFile &) const
	Decode and create a new EBML element instance from `ebml::parseFile` instance. More...

ebmlElement *	_decode (const char *, size_t) const
	Decode from a raw data buffer. More...

ebmlElement *	_decode (const std::string &) const
	Decode from `std::string`. More...

ebmlElement *	_decode (ioBase &) const
	Decode and create a new EBML element instance from `ebml::ioBase` instance at the current file position. More...

ebmlElement *	_decode (ioBase &, off_t &) const
	Decode and create a new EBML element instance from `ebml::ioBase` instance with a specified offset. More...

ebmlElement *	_decode (ioBase &, off_t, off_t &) const
	Decode from `ebml::ioBase` instance with a specified offset and store the end offset. More...

ebmlElement *	_cdecode (const parseString &) const

ebmlElement *	_cdecode (const parseFile &) const

ebmlElement *	_cdecode (const char *, size_t) const

ebmlElement *	_cdecode (const std::string &) const

ebmlElement *	_cdecode (ioBase &) const

ebmlElement *	_cdecode (ioBase &, off_t &offset) const

ebmlElement *	_cdecode (ioBase &, off_t offset, off_t &end) const

Protected Attributes inherited from ebml::ebmlMasterElementType
childTypeSpec_t	_childTypes

Detailed Description

Represents a structure-like EBML master element.

This class defines an EBML element type that acts as a structure or record, containing a fixed set of named children. It provides a way to enforce a specific schema or structure within the EBML document.

Constructor & Destructor Documentation

◆ ebmlStructType() [1/4]

ebml::ebmlStructType::ebmlStructType	(	const char *	ebmlID,
		const std::wstring &	name,
		const slotSpec_l &	slotSpecs
	)

◆ ebmlStructType() [2/4]

ebml::ebmlStructType::ebmlStructType	(	ebmlID_t	ebmlID,
		const std::wstring &	name,
		const slotSpec_l &	slotSpecs
	)

◆ ebmlStructType() [3/4]

ebml::ebmlStructType::ebmlStructType	(	const char *	ebmlID,
		const std::wstring &	name,
		const slotSpec_l &	slotSpecs,
		const seekHelper_t *	seekHelper
	)

◆ ebmlStructType() [4/4]

ebml::ebmlStructType::ebmlStructType	(	ebmlID_t	ebmlID,
		const std::wstring &	name,
		const slotSpec_l &	slotSpecs,
		const seekHelper_t *	seekHelper
	)

Member Function Documentation

◆ slotSpecs()

const std::vector< slotSpec_t > & ebml::ebmlStructType::slotSpecs ( ) const

◆ slotSpecsByID()

const std::unordered_map< ebmlID_t, const slotSpec_t * > & ebml::ebmlStructType::slotSpecsByID ( ) const

◆ slotSpecsByKey()

const std::unordered_map< std::string, const slotSpec_t * > & ebml::ebmlStructType::slotSpecsByKey ( ) const

◆ typeBySlot() [1/2]

const ebmlElementType * ebml::ebmlStructType::typeBySlot ( const std::string & key ) const

◆ typeBySlot() [2/2]

const ebmlElementType * ebml::ebmlStructType::typeBySlot ( size_t index ) const

Friends And Related Function Documentation

◆ ebmlStruct

friend class ebmlStruct

friend

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

src/libebml_ng/masterelement/ebmlStruct.h
src/libebml_ng/masterelement/ebmlStruct.cpp

Public Member Functions

Friends

Additional Inherited Members