logo

Struct rkyv::with::Raw

source · []
pub struct Raw;
Expand description

A wrapper that provides an optimized bulk data array. This is primarily intended for large amounts of raw data, like bytes, floats, or integers.

This wrapper can be used with containers like Vec, but care must be taken to ensure that they contain copy-safe types. Copy-safe types must be trivially copyable (have the same archived and unarchived representations) and contain no padding bytes. In situations where copying uninitialized bytes the output is acceptable, this wrapper may be used with containers of types that contain padding bytes.

Unlike CopyOptimize, this wrapper will also skip validation for its elements. If the elements of the container can have any invalid bit patterns (e.g. char, bool, complex containers, etc.), then using Raw in an insecure setting can lead to undefined behavior. Take great caution!

Safety

Using this wrapper with containers containing non-copy-safe types or types that require validation may result in undefined behavior.

Example

use rkyv::{Archive, with::Raw};

#[derive(Archive)]
struct Example {
    #[with(Raw)]
    bytes: Vec<u8>,
    #[with(Raw)]
    vertices: Vec<[f32; 3]>,
}

Trait Implementations

The archived type of a With<F, Self>.

The resolver of a With<F, Self>.

Resolves the archived type using a reference to the field type F. Read more

Formats the value using the given formatter. Read more

Deserializes the field type F using the given deserializer.

Serializes the field type F using the given serializer.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

The archived version of the pointer metadata for this type.

Converts some archived metadata to the pointer metadata for itself.

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Deserializes using the given deserializer

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type for metadata in pointers and references to Self.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.