Skip to main content

AnnotationBlock

Struct AnnotationBlock 

Source
pub struct AnnotationBlock {
    pub target_block_id: u32,
    pub kind: AnnotationKind,
    pub value: Vec<u8>,
}
Expand description

ANNOTATION block — metadata overlay for other blocks.

Annotations are secondary blocks that attach metadata to a primary block identified by target_block_id (the zero-based index of the target block in the stream). The kind field determines how the value payload should be interpreted:

  • Priority: value is a Priority byte
  • Summary: value is UTF-8 text summarizing the target block
  • Tag: value is a UTF-8 label/tag string

Field layout within body:

┌──────────┬───────────┬─────────────────┬──────────────────────┐
│ Field ID │ Wire Type │ Name            │ Description          │
├──────────┼───────────┼─────────────────┼──────────────────────┤
│ 1        │ Varint    │ target_block_id │ Index of target blk  │
│ 2        │ Varint    │ kind            │ AnnotationKind byte  │
│ 3        │ Bytes     │ value           │ Annotation payload   │
└──────────┴───────────┴─────────────────┴──────────────────────┘

Fields§

§target_block_id: u32§kind: AnnotationKind§value: Vec<u8>

Implementations§

Source§

impl AnnotationBlock

Source

pub fn encode_body(&self) -> Vec<u8>

Serialize this block’s fields into a TLV-encoded body.

Source

pub fn decode_body(buf: &[u8]) -> Result<Self, TypeError>

Deserialize an ANNOTATION block from a TLV-encoded body.

Trait Implementations§

Source§

impl Clone for AnnotationBlock

Source§

fn clone(&self) -> AnnotationBlock

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AnnotationBlock

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for AnnotationBlock

Source§

fn eq(&self, other: &AnnotationBlock) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for AnnotationBlock

Source§

impl StructuralPartialEq for AnnotationBlock

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.