Skip to main content

BlockType

Enum BlockType 

Source
pub enum BlockType {
Show 13 variants Code, Conversation, FileTree, ToolResult, Document, StructuredData, Diff, Annotation, EmbeddingRef, Image, Extension, End, Unknown(u8),
}
Expand description

Semantic block type identifiers.

Each variant maps to the wire byte value defined in RFC §4.4 and mirrored by the bcp_wire::block_frame::block_type constants. Unknown values are captured by Unknown(u8) for forward compatibility — a newer encoder may produce block types this version doesn’t recognize, and we preserve them rather than discarding.

┌──────┬──────────────────┬──────────────────────────────────┐
│ Wire │ Variant          │ Description                      │
├──────┼──────────────────┼──────────────────────────────────┤
│ 0x01 │ Code             │ Source code with language/path    │
│ 0x02 │ Conversation     │ Chat turn with role              │
│ 0x03 │ FileTree         │ Directory structure              │
│ 0x04 │ ToolResult       │ Tool/MCP output                  │
│ 0x05 │ Document         │ Prose/markdown content           │
│ 0x06 │ StructuredData   │ JSON/YAML/TOML/CSV data          │
│ 0x07 │ Diff             │ Code changes with hunks          │
│ 0x08 │ Annotation       │ Metadata overlay                 │
│ 0x09 │ EmbeddingRef     │ Vector reference                 │
│ 0x0A │ Image            │ Image reference or embed         │
│ 0xFE │ Extension        │ User-defined block               │
│ 0xFF │ End              │ End-of-stream sentinel           │
└──────┴──────────────────┴──────────────────────────────────┘

Variants§

§

Code

§

Conversation

§

FileTree

§

ToolResult

§

Document

§

StructuredData

§

Diff

§

Annotation

§

EmbeddingRef

§

Image

§

Extension

§

End

§

Unknown(u8)

Forward-compatible catch-all for block types this version doesn’t recognize. The raw wire byte is preserved so it can be re-encoded without loss.

Implementations§

Source§

impl BlockType

Source

pub fn wire_id(&self) -> u8

Return the single-byte wire ID for this block type.

For known variants this is the constant from RFC §4.4. For Unknown(id), returns the captured byte as-is.

Source

pub fn from_wire_id(id: u8) -> Self

Parse a wire byte into a BlockType.

Known values map to their named variant. Anything else becomes Unknown(id), preserving the raw value for round-tripping.

Trait Implementations§

Source§

impl Clone for BlockType

Source§

fn clone(&self) -> BlockType

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 BlockType

Source§

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

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

impl PartialEq for BlockType

Source§

fn eq(&self, other: &BlockType) -> 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 BlockType

Source§

impl StructuralPartialEq for BlockType

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.