logo
pub struct Unsafe;
Expand description

A wrapper that allows serialize-unsafe types to be serialized.

Types like Cell and UnsafeCell may contain serializable types, but have unsafe access semantics due to interior mutability. They may be safe to serialize, but only under conditions that rkyv is unable to guarantee.

This wrapper enables serializing these types, and places the burden of verifying that their access semantics are used safely on the user.

Safety

Using this wrapper on types with interior mutability can create races conditions or allow access to data in an invalid state if access semantics are not followed properly. During serialization, the data must not be modified.

Example

use rkyv::{Archive, with::Unsafe};
use core::cell::{Cell, UnsafeCell};

#[derive(Archive)]
struct Example {
    #[with(Unsafe)]
    cell: Cell<String>,
    #[with(Unsafe)]
    unsafe_cell: UnsafeCell<String>,
}

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

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.

Deserializes the field type F using the given deserializer.

Serializes the field type F using the given serializer.

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.