Struct GenericLayerBuilder 

pub struct GenericLayerBuilder { /* private fields */ }

Builder for dynamically-defined custom protocol layers.

This builder is intended to be constructed once per protocol definition (e.g. in Python via the PyO3 bindings) and then used to produce byte buffers that conform to the protocol layout.

Example

use std::sync::Arc;
use stackforge_core::layer::generic::builder::GenericLayerBuilder;
use stackforge_core::layer::generic::GenericFieldDesc;
use stackforge_core::layer::field::FieldType;

let fields = Arc::new(vec![
    GenericFieldDesc {
        name: "type_id".to_string(),
        offset: 0,
        size: 2,
        field_type: FieldType::U16,
        default_value: vec![0x00, 0x01],
    },
    GenericFieldDesc {
        name: "flags".to_string(),
        offset: 2,
        size: 1,
        field_type: FieldType::U8,
        default_value: vec![0x00],
    },
]);

let buf = GenericLayerBuilder::new(Arc::from("MyProto"), fields)
    .set_u16("type_id", 0x0042)
    .build();

assert_eq!(buf.len(), 3);
assert_eq!(buf[0], 0x00);
assert_eq!(buf[1], 0x42);
assert_eq!(buf[2], 0x00);

Implementations

impl GenericLayerBuilder

pub fn new(name: Arc<str>, field_descs: Arc<Vec<GenericFieldDesc>>) -> Self

Create a builder for the named protocol with the given field descriptors.

pub fn set(self, name: &str, value: Vec<u8>) -> Self

Set a field by raw bytes.

If value is shorter than the field’s declared size it is zero-padded (on the right); if it is longer it is truncated.

pub fn set_u8(self, name: &str, value: u8) -> Self

Set a U8 field by name.

pub fn set_u16(self, name: &str, value: u16) -> Self

Set a U16 field by name (stored big-endian).

pub fn set_u32(self, name: &str, value: u32) -> Self

Set a U32 field by name (stored big-endian).

pub fn header_size(&self) -> usize

Total byte size of the protocol header (sum of all field sizes).

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

Build the layer into a byte buffer.

Fields not explicitly set fall back to their default_value. Each field value is copied into the buffer starting at field.offset, padded with zeros on the right or truncated if the value’s length does not match field.size.

pub fn build_layer(&self) -> (GenericLayer, Vec<u8>)

Build the byte buffer and wrap it in a GenericLayer.

The returned layer’s LayerIndex covers [0..header_size] within the returned byte buffer.

pub fn name(&self) -> &str

The protocol name.

pub fn kind(&self) -> LayerKind

The layer kind (always LayerKind::Generic).

Trait Implementations

impl Clone for GenericLayerBuilder

fn clone(&self) -> GenericLayerBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericLayerBuilder

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

Formats the value using the given formatter.