Struct StyxSerializer 

pub struct StyxSerializer { /* private fields */ }

Styx serializer with configurable formatting options.

Implementations

impl StyxSerializer

pub fn new() -> Self

Create a new Styx serializer with default options.

pub fn with_options(options: FormatOptions) -> Self

Create a new Styx serializer with the given options.

pub fn finish(self) -> Vec<u8>

Consume the serializer and return the output bytes, ensuring trailing newline.

Trait Implementations

impl Default for StyxSerializer

fn default() -> Self

Returns the “default value” for a type.

impl FormatSerializer for StyxSerializer

type Error = StyxSerializeError

Format-specific error type.

fn begin_struct(&mut self) -> Result<(), Self::Error>

Begin a map/object/struct.

fn field_key(&mut self, key: &str) -> Result<(), Self::Error>

Emit a field key within a struct.

fn emit_field_key(&mut self, key: &FieldKey<'_>) -> Result<(), Self::Error>

Emit a rich field key with optional tag and documentation.

fn end_struct(&mut self) -> Result<(), Self::Error>

End a map/object/struct.

fn begin_seq(&mut self) -> Result<(), Self::Error>

Begin a sequence/array.

fn end_seq(&mut self) -> Result<(), Self::Error>

End a sequence/array.

fn scalar(&mut self, scalar: ScalarValue<'_>) -> Result<(), Self::Error>

Emit a scalar value.

fn serialize_none(&mut self) -> Result<(), Self::Error>

Serialize Option::None.

fn write_variant_tag(&mut self, variant_name: &str) -> Result<bool, Self::Error>

Write a tag for an externally-tagged enum variant.

fn begin_struct_after_tag(&mut self) -> Result<(), Self::Error>

Begin a struct directly after a variant tag (no separator).

fn begin_seq_after_tag(&mut self) -> Result<(), Self::Error>

Begin a sequence directly after a variant tag (no separator).

fn raw_serialize_shape(&self) -> Option<&'static Shape>

Returns the shape of the format’s raw capture type for serialization.

fn raw_scalar(&mut self, content: &str) -> Result<(), Self::Error>

Emit a raw scalar value (for RawJson, etc.) without any encoding/escaping.

fn serialize_map_key(&mut self, key: Peek<'_, '_>) -> Result<bool, Self::Error>

Serialize a map key in MapEncoding::Struct mode.

fn field_metadata_with_value( &mut self, field_item: &FieldItem, value: Peek<'_, '_>, ) -> Result<bool, Self::Error>

Optional: Provide field metadata with access to the field value.

fn field_metadata(&mut self, _field: &FieldItem) -> Result<(), Self::Error>

Optional: Provide field metadata before field_key is called. Default implementation does nothing.

fn struct_metadata(&mut self, _shape: &Shape) -> Result<(), Self::Error>

Optional: Provide struct/enum type metadata when beginning to serialize it. Default implementation does nothing.

fn variant_metadata( &mut self, _variant: &'static Variant, ) -> Result<(), Self::Error>

Optional: Provide variant metadata before serializing an enum variant. Default implementation does nothing.

fn serialize_metadata_container( &mut self, _container: &PeekStruct<'_, '_>, ) -> Result<bool, Self::Error>

Serialize a metadata container value.

fn preferred_field_order(&self) -> FieldOrdering

Preferred field ordering for this format. Default is declaration order.

fn struct_field_mode(&self) -> StructFieldMode

Preferred struct field mode for this format.

fn map_encoding(&self) -> MapEncoding

Preferred map encoding for this format.

fn enum_variant_encoding(&self) -> EnumVariantEncoding

Preferred enum variant encoding for this format.

fn is_self_describing(&self) -> bool

Whether this format is self-describing (includes type information).

fn dynamic_value_encoding(&self) -> DynamicValueEncoding

Preferred dynamic value encoding for this format.

fn serialize_opaque_scalar( &mut self, _shape: &'static Shape, _value: Peek<'_, '_>, ) -> Result<bool, Self::Error>

Serialize an opaque scalar type with a format-specific encoding.

fn dynamic_value_tag( &mut self, _tag: DynamicValueTag, ) -> Result<(), Self::Error>

Emit a dynamic value type tag.

fn begin_seq_with_len(&mut self, _len: usize) -> Result<(), Self::Error>

Begin a sequence with known length.

fn begin_map_with_len(&mut self, _len: usize) -> Result<(), Self::Error>

Begin serializing a map with known length.

fn end_map(&mut self) -> Result<(), Self::Error>

End a map/object/struct.

fn typed_scalar( &mut self, scalar_type: ScalarType, value: Peek<'_, '_>, ) -> Result<(), Self::Error>

Serialize a scalar with full type information.

fn begin_option_some(&mut self) -> Result<(), Self::Error>

Begin serializing Option::Some(value).

fn begin_enum_variant( &mut self, _variant_index: usize, _variant_name: &'static str, ) -> Result<(), Self::Error>

Begin an enum variant with its index and name.

fn serialize_byte_sequence( &mut self, _bytes: &[u8], ) -> Result<bool, Self::Error>

Serialize a byte sequence (Vec<u8>, &[u8], etc.) in bulk.

fn serialize_byte_array(&mut self, _bytes: &[u8]) -> Result<bool, Self::Error>

Serialize a fixed-size byte array ([u8; N]) in bulk.

fn format_namespace(&self) -> Option<&'static str>

Returns the format namespace for format-specific proxy resolution.