Struct Unsafe

pub struct Unsafe;

Available on crate feature dep_rkyv only.

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 core::cell::{Cell, UnsafeCell};

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

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

Trait Implementations

impl<F> ArchiveWith<Cell<F>> for Unsafe

where F: Archive,

type Archived = <F as Archive>::Archived

The archived type of Self with F.

type Resolver = <F as Archive>::Resolver

The resolver of a Self with F.

fn resolve_with( field: &Cell<F>, resolver: <Unsafe as ArchiveWith<Cell<F>>>::Resolver, out: Place<<Unsafe as ArchiveWith<Cell<F>>>::Archived>, )

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

impl<F> ArchiveWith<UnsafeCell<F>> for Unsafe

where F: Archive,

type Archived = <F as Archive>::Archived

The archived type of Self with F.

type Resolver = <F as Archive>::Resolver

The resolver of a Self with F.

fn resolve_with( field: &UnsafeCell<F>, resolver: <Unsafe as ArchiveWith<UnsafeCell<F>>>::Resolver, out: Place<<Unsafe as ArchiveWith<UnsafeCell<F>>>::Archived>, )

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

impl Debug for Unsafe

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

Formats the value using the given formatter.

impl<F, D> DeserializeWith<<F as Archive>::Archived, Cell<F>, D> for Unsafe

where F: Archive, <F as Archive>::Archived: Deserialize<F, D>, D: Fallible + ?Sized,

fn deserialize_with( field: &<F as Archive>::Archived, deserializer: &mut D, ) -> Result<Cell<F>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<F, D> DeserializeWith<<F as Archive>::Archived, UnsafeCell<F>, D> for Unsafe

where F: Archive, <F as Archive>::Archived: Deserialize<F, D>, D: Fallible + ?Sized,

fn deserialize_with( field: &<F as Archive>::Archived, deserializer: &mut D, ) -> Result<UnsafeCell<F>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<F, S> SerializeWith<Cell<F>, S> for Unsafe

where F: Serialize<S>, S: Fallible + ?Sized,

fn serialize_with( field: &Cell<F>, serializer: &mut S, ) -> Result<<Unsafe as ArchiveWith<Cell<F>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.

impl<F, S> SerializeWith<UnsafeCell<F>, S> for Unsafe

where F: Serialize<S>, S: Fallible + ?Sized,

fn serialize_with( field: &UnsafeCell<F>, serializer: &mut S, ) -> Result<<Unsafe as ArchiveWith<UnsafeCell<F>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.