Struct RkyvFormat 

pub struct RkyvFormat { /* private fields */ }

Available on crate feature rkyv_format only.

Rkyv format - high-performance zero-copy serialization (rkyv 0.8)

Buffer Allocation

RkyvFormat pre-allocates a buffer to reduce reallocations during serialization. The buffer hint can be configured based on your typical payload size:

• Small payloads (<1KB): Use RkyvFormat::new() (default 4KB)
• Medium payloads (1KB-100KB): Use RkyvFormat::with_buffer_hint(16384) (16KB)
• Large payloads (>100KB): Use RkyvFormat::with_buffer_hint(131072) (128KB)

Examples

use hitbox_backend::RkyvFormat;

// Default buffer size (4KB)
let format = RkyvFormat::new();

// Custom buffer size for large payloads
let format = RkyvFormat::with_buffer_hint(128 * 1024);

Implementations

impl RkyvFormat

pub const DEFAULT_BUFFER_HINT: usize = 4096

Default buffer size (4KB) - suitable for most small to medium payloads

pub const fn new() -> Self

Creates a new RkyvFormat with the default buffer hint (4KB)

pub const fn with_buffer_hint(buffer_hint: usize) -> Self

Creates a new RkyvFormat with a custom buffer hint

Arguments

• buffer_hint - Initial buffer capacity in bytes

Examples

use hitbox_backend::RkyvFormat;

// For large payloads (128KB)
let format = RkyvFormat::with_buffer_hint(128 * 1024);

pub const fn buffer_hint(&self) -> usize

Returns the configured buffer hint

Trait Implementations

impl Clone for RkyvFormat

fn clone(&self) -> RkyvFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RkyvFormat

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

Formats the value using the given formatter.

impl Default for RkyvFormat

fn default() -> Self

Returns the “default value” for a type.

impl Format for RkyvFormat

fn with_serializer( &self, f: &mut dyn FnMut(&mut FormatSerializer<'_>) -> Result<(), FormatError>, _context: &dyn Context, ) -> Result<Raw, FormatError>

Serializes a value through a callback.

fn with_deserializer( &self, data: &[u8], f: &mut dyn FnMut(&mut FormatDeserializer<'_>) -> Result<(), FormatError>, _ctx: &mut BoxContext, ) -> Result<(), FormatError>

Deserializes a value through a callback.

fn clone_box(&self) -> Box<dyn Format>

Clones this format into a boxed trait object.

fn format_type_id(&self) -> FormatTypeId

Returns this format’s type identifier.

impl Copy for RkyvFormat