Module alkahest::advanced

This module contains types and functions for manual implementations of Serialize and Deserialize traits.

Structs

• CheckedFixedBuffer
  Fixed buffer without bound checks. If buffer is too small to fit serialized data, it will panic.
• Deserializer
  Deserializer from raw bytes. Provides methods for deserialization of values.
• FixedIsize
  Type used to represent sizes and offsets in serialized data. This places limitation on sequence sizes which practically is never hit. usize itself is not portable and cannot be written into alkahest package.
• MaybeFixedBuffer
  Buffer that writes to a slice. If buffer is too small to fit serialized data it keeps pretends to work and tracks the size of the values that would be written. Returns BufferSizeRequired error if serialized data is too big.
• Sizes
  Heap and stack sizes.
• SliceWriter
  Writes elements of a slice one by one into associated buffer.
• VecBuffer
  Extensible buffer that writes to a vector. If buffer is too small to fit serialized data it extends the vector. Never returns an error, cannot fail to serialize data except for OOM error.

Traits

• BareFormula
  Ad-hoc negative trait. It should be implemented for most formulas. Except for formulas with generic implementation of Serialize and Deserialize traits via another Formula.
• Buffer
  Buffer API that is used by serializer. Buffers can be extensible or fixed size. Extensible buffers grow automatically when needed.

Functions

• default_iter_fast_sizes
  Returns the size of the serialized data if it can be determined fast.
• deserialize_extend_iter
  Deserialize into Extend value from slice formula.
• deserialize_from_iter
  Deserialize FromIterator value from slice formula.
• field_size_hint
  Size hint for serializing a field.
• formula_fast_sizes
  Returns size hint for the formula if it is known at compile time.
• reference_size
  Returns size of formula reference.
• slice_writer
  Returns a writer to write elements of a slice one by one into associated buffer.
• write_array
  Writes array into buffer.
• write_bytes
  Write raw bytes to the buffer.
• write_exact_size_field
  Write a field with exact size into buffer. Requires that F::EXACT_SIZE is true and F::MAX_STACK_SIZE is Some.
• write_field
  Writes field value into the buffer.
• write_ref
  Write value to the buffer as a reference, placing value into the heap and reference into the stack.
• write_reference
  Writes reference into the buffer.
• write_slice
  Writes iterator into buffer.

Type Definitions

• FixedIsizeType
  Type used to represent sizes and offsets in serialized data.