Skip to main content

Module common

Module common 

Source
Expand description

Shared wire types for TypeObject (Minimal + Complete).

XTypes §7.3.4.5 (CommonStructMember, NameHash, MemberId).

Structs§

AppliedAnnotation
AppliedAnnotation: instance of a custom annotation on a type/member.
AppliedAnnotationParameter
AppliedAnnotationParameter (§7.3.4.5.4): a named parameter of an annotation instance. The parameter name is stored as a 4-byte hash (saves payload).
AppliedBuiltinMemberAnnotations
AppliedBuiltinMemberAnnotations (§7.3.4.5.4) — Member-spezifische Builtin-Annotations.
AppliedBuiltinTypeAnnotations
AppliedBuiltinTypeAnnotations (§7.3.4.5.4): @verbatim at type level.
AppliedVerbatimAnnotation
@verbatim(language, text, placement).
CommonStructMember
CommonStructMember (§7.3.4.5.2).
CommonUnionMember
CommonUnionMember (§7.3.4.5.3). Additionally contains the label list.
CompleteMemberDetail
CompleteMemberDetail: name + ann_builtin + ann_custom.
CompleteTypeDetail
CompleteTypeDetail (§7.3.4.5.4): ann_builtin + ann_custom + type_name.
NameHash
4-byte name hash (§7.3.4.5 — “MD5(name)[0..4]”).
OptionalAppliedAnnotationSeq
Optionales sequence<AppliedAnnotation> — wire: sequence<T, 1>.

Enums§

VerbatimPlacement
Placement kind of a @verbatim annotation (§7.3.4.5.4 §PL_*).

Constants§

DECODE_PREALLOC_CAP
DoS cap for Vec pre-allocation during decode. The value is the upper bound in elements that we allocate initially. Large sequences are grown incrementally via push().

Type Aliases§

MemberId
32-bit member ID (§7.3.4.5). Either assigned explicitly via @id(n) or hashed from the member name (@autoid(HASH)).
QualifiedTypeName
Full qualified type name, e.g. “::sensors::Chatter”. Alias for String — on the wire as a CDR string (u32 length + UTF-8 + null-term).