ebml

Documentation

Index

• Constants
• Variables
• type Binary
  • func (*Binary) GetType() string
• type Date
  • func (*Date) GetType() string
• type Element
  • func FindParentID(idToElement map[ID]Element, startID ID, id ID) (Element, bool)
• type ElementScalarType
  • func (e *ElementScalarType[T]) GetEnum() map[T]Enum
• type ElementType
  • func (e *ElementType) GetDefinition() string
  • func (e *ElementType) GetID() ID
  • func (e *ElementType) GetName() string
  • func (e *ElementType) GetParentID() ID
  • func (e *ElementType) GetType() string
• type Enum
• type Float
  • func (*Float) GetType() string
• type ID
• type Integer
  • func (*Integer) GetType() string
• type Master
  • func (e *Master) GetMaster() map[ID]Element
  • func (e *Master) GetType() string
• type String
  • func (*String) GetType() string
• type UTF8
  • func (*UTF8) GetType() string
• type Uinteger
  • func (*Uinteger) GetType() string
• type Unknown
  • func (*Unknown) GetType() string

Constants

const (
	RootID = 0

	CRC32ID = 0xbf
	VoidID  = 0xec
)

const (
	HeaderID             = 0x1a45dfa3
	EBMLVersionID        = 0x4286
	EBMLReadVersionID    = 0x42f7
	EBMLMaxIDLengthID    = 0x42f2
	EBMLMaxSizeLengthID  = 0x42f3
	DocTypeID            = 0x4282
	DocTypeVersionID     = 0x4287
	DocTypeReadVersionID = 0x4285
)

Variables

var Global = &Master{
	ElementType: ElementType{
		ID:       -1,
		ParentID: -1,
		Name:     "",
	},
	Master: map[ID]Element{
		CRC32ID: &Binary{ElementType: ElementType{Name: "crc32"}},
		VoidID:  &Binary{ElementType: ElementType{Name: "void"}},
	},
}

var Header = &Master{
	ElementType: ElementType{
		ID:       HeaderID,
		ParentID: RootID,
		Name:     "ebml",
	},
	Master: map[ID]Element{
		EBMLVersionID:        &Uinteger{ElementType: ElementType{Name: "ebml_version", Definition: "EBML Version"}},
		EBMLReadVersionID:    &Uinteger{ElementType: ElementType{Name: "ebml_read_version", Definition: "Minimum EBML reader version"}},
		EBMLMaxIDLengthID:    &Uinteger{ElementType: ElementType{Name: "ebml_max_id_length", Definition: "Maximum id length"}},
		EBMLMaxSizeLengthID:  &Uinteger{ElementType: ElementType{Name: "ebml_max_size_length", Definition: "Maximum body length"}},
		DocTypeID:            &String{ElementType: ElementType{Name: "doc_type", Definition: "Document content type"}},
		DocTypeVersionID:     &Uinteger{ElementType: ElementType{Name: "doc_type_version", Definition: "Document type version"}},
		DocTypeReadVersionID: &Uinteger{ElementType: ElementType{Name: "doc_type_read_version", Definition: "Minimum document reader version"}},
	},
}

Types

type Binary

type Binary struct{ ElementType }

func (*Binary) GetType

func (*Binary) GetType() string

type Date

type Date struct{ ElementType }

func (*Date) GetType

func (*Date) GetType() string

type Element

type Element interface {
	GetType() string
	GetID() ID
	GetParentID() ID
	GetName() string
	GetDefinition() string
}

func FindParentID

func FindParentID(idToElement map[ID]Element, startID ID, id ID) (Element, bool)

FindParentID find id walking parents of startID

type ElementScalarType

type ElementScalarType[T comparable] struct {
	ElementType
	Enums map[T]Enum
}

func (*ElementScalarType[T]) GetEnum

func (e *ElementScalarType[T]) GetEnum() map[T]Enum

type ElementType

type ElementType struct {
	ID         ID
	ParentID   ID
	Name       string
	Definition string
}

func (*ElementType) GetDefinition

func (e *ElementType) GetDefinition() string

func (*ElementType) GetID

func (e *ElementType) GetID() ID

func (*ElementType) GetName

func (e *ElementType) GetName() string

func (*ElementType) GetParentID

func (e *ElementType) GetParentID() ID

func (*ElementType) GetType

func (e *ElementType) GetType() string

type Enum

type Enum struct {
	Name        string
	Description string
}

type Float

type Float ElementScalarType[float64]

func (*Float) GetType

func (*Float) GetType() string

type ID

type ID int

type Integer

type Integer ElementScalarType[int64]

func (*Integer) GetType

func (*Integer) GetType() string

type Master

type Master struct {
	ElementType
	Master map[ID]Element
}

func (*Master) GetMaster

func (e *Master) GetMaster() map[ID]Element

func (*Master) GetType

func (e *Master) GetType() string

type String

type String ElementScalarType[string]

func (*String) GetType

func (*String) GetType() string

type UTF8

type UTF8 ElementScalarType[string]

func (*UTF8) GetType

func (*UTF8) GetType() string

type Uinteger

type Uinteger ElementScalarType[uint64]

func (*Uinteger) GetType

func (*Uinteger) GetType() string

type Unknown

type Unknown struct{ ElementType }

func (*Unknown) GetType

func (*Unknown) GetType() string