Skip to main content

PostbagSlim

Struct PostbagSlim 

Source
pub struct PostbagSlim;
Available on crate feature serde only.
Expand description

Postbag slim codec for compact, high-performance encoding.

The Slim configuration prioritizes performance and compact size over compatibility. This codec provides efficient binary encoding but with limited schema evolution capabilities compared to the full Postbag codec.

ยงKey Features

  • Compact encoding: Smaller serialized data size compared to Full configuration
  • Fast processing: No string lookups during serialization/deserialization
  • High performance: Optimized for speed and minimal overhead

ยงSchema Evolution Limitations

The Slim configuration has limited schema evolution capabilities. Fields and enum variants must maintain their order for compatibility.

ยงSupported Changes

  • Adding fields: New fields can be added to the end of structs only
  • Removing fields: Fields can be removed from the end of structs only
  • Adding enum variants: New variants can be added at the end of enums only
  • Removing enum variants: Variants can be removed from the end of enums only

ยงImportant Compatibility Notes

  • Fields and enum variants cannot be reordered
  • Fields and enum variants cannot be added or removed from the middle
  • Use serde defaults (#[serde(default)]) for new fields to ensure backward compatibility
  • Always add new fields at the end of struct definitions
  • Always add new enum variants at the end of enum definitions

ยงWhen to Use

Choose PostbagSlim when:

  • Maximum performance and minimal serialized size are priorities
  • Schema changes are infrequent or controlled
  • Data structures have stable field ordering

Choose the full Postbag codec when schema flexibility is more important than the slight performance overhead.

This serializes and deserializes without field identifiers for maximum efficiency.

Trait Implementationsยง

Sourceยง

impl Clone for PostbagSlim

Sourceยง

fn clone(&self) -> PostbagSlim

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Codec for PostbagSlim

Sourceยง

fn serialize<Writer, Item>( writer: Writer, item: &Item, ) -> Result<(), SerializationError>
where Writer: Write, Item: Serialize,

Serializes the specified item into the data format.
Sourceยง

fn deserialize<Reader, Item>( reader: Reader, ) -> Result<Item, DeserializationError>
where Reader: Read, Item: DeserializeOwned,

Deserializes the specified data into an item.
Sourceยง

impl<'de> Deserialize<'de> for PostbagSlim

Sourceยง

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Sourceยง

impl Serialize for PostbagSlim

Sourceยง

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Sourceยง

impl<T> RemoteSend for T
where T: Send + Serialize + DeserializeOwned + 'static,