Struct Lock

pub struct Lock;

Available on crate feature dep_rkyv only.

A wrapper that locks a lock and serializes the value immutably.

This wrapper can panic under very specific circumstances when:

1. serialize_with is called and succeeds in locking the value to serialize it.
2. Another thread locks the value and panics, poisoning the lock
3. resolve_with is called and gets a poisoned value.

Unfortunately, it’s not possible to work around this issue internally. Users must ensure this doesn’t happen on their own through manual synchronization or guaranteeing that panics do not occur while holding locks.

Example

use std::sync::Mutex;

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

#[derive(Archive)]
struct Example {
    #[rkyv(with = Lock)]
    a: Mutex<i32>,
}

Trait Implementations

impl<F> ArchiveWith<Mutex<F>> for Lock

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: &Mutex<F>, resolver: <Lock as ArchiveWith<Mutex<F>>>::Resolver, out: Place<<Lock as ArchiveWith<Mutex<F>>>::Archived>, )

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

impl<F> ArchiveWith<RwLock<F>> for Lock

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: &RwLock<F>, resolver: <Lock as ArchiveWith<RwLock<F>>>::Resolver, out: Place<<Lock as ArchiveWith<RwLock<F>>>::Archived>, )

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

impl Debug for Lock

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

Formats the value using the given formatter.

impl<F, T, D> DeserializeWith<F, Mutex<T>, D> for Lock

where F: Deserialize<T, D>, D: Fallible + ?Sized,

fn deserialize_with( field: &F, deserializer: &mut D, ) -> Result<Mutex<T>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<F, T, D> DeserializeWith<F, RwLock<T>, D> for Lock

where F: Deserialize<T, D>, D: Fallible + ?Sized,

fn deserialize_with( field: &F, deserializer: &mut D, ) -> Result<RwLock<T>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<F, S> SerializeWith<Mutex<F>, S> for Lock

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

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

Serializes the field type F using the given serializer.

impl<F, S> SerializeWith<RwLock<F>, S> for Lock

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

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

Serializes the field type F using the given serializer.