Struct AsVec

pub struct AsVec;

Available on crate feature dep_rkyv only.

A wrapper that serializes associative containers as a Vec of key-value pairs.

This provides faster serialization for containers like HashMap and BTreeMap by serializing the key-value pairs directly instead of building a data structure in the buffer.

Example

use std::collections::HashMap;

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

#[derive(Archive)]
struct Example {
    #[rkyv(with = AsVec)]
    values: HashMap<String, u32>,
}

Trait Implementations

impl<const A: usize> ArchiveWith<AlignedVec<A>> for AsVec

type Archived = ArchivedVec<u8>

The archived type of Self with F.

type Resolver = VecResolver

The resolver of a Self with F.

fn resolve_with( field: &AlignedVec<A>, resolver: <AsVec as ArchiveWith<AlignedVec<A>>>::Resolver, out: Place<<AsVec as ArchiveWith<AlignedVec<A>>>::Archived>, )

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

impl<K, V> ArchiveWith<BTreeMap<K, V>> for AsVec

where K: Archive, V: Archive,

type Archived = ArchivedVec<Entry<<K as Archive>::Archived, <V as Archive>::Archived>>

The archived type of Self with F.

type Resolver = VecResolver

The resolver of a Self with F.

fn resolve_with( field: &BTreeMap<K, V>, resolver: <AsVec as ArchiveWith<BTreeMap<K, V>>>::Resolver, out: Place<<AsVec as ArchiveWith<BTreeMap<K, V>>>::Archived>, )

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

impl<T> ArchiveWith<BTreeSet<T>> for AsVec

where T: Archive,

type Archived = ArchivedVec<<T as Archive>::Archived>

The archived type of Self with F.

type Resolver = VecResolver

The resolver of a Self with F.

fn resolve_with( field: &BTreeSet<T>, resolver: <AsVec as ArchiveWith<BTreeSet<T>>>::Resolver, out: Place<<AsVec as ArchiveWith<BTreeSet<T>>>::Archived>, )

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

impl<K, V, H> ArchiveWith<HashMap<K, V, H>> for AsVec

where K: Archive, V: Archive,

type Archived = ArchivedVec<Entry<<K as Archive>::Archived, <V as Archive>::Archived>>

The archived type of Self with F.

type Resolver = VecResolver

The resolver of a Self with F.

fn resolve_with( field: &HashMap<K, V, H>, resolver: <AsVec as ArchiveWith<HashMap<K, V, H>>>::Resolver, out: Place<<AsVec as ArchiveWith<HashMap<K, V, H>>>::Archived>, )

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

impl<T, H> ArchiveWith<HashSet<T, H>> for AsVec

where T: Archive,

type Archived = ArchivedVec<<T as Archive>::Archived>

The archived type of Self with F.

type Resolver = VecResolver

The resolver of a Self with F.

fn resolve_with( field: &HashSet<T, H>, resolver: <AsVec as ArchiveWith<HashSet<T, H>>>::Resolver, out: Place<<AsVec as ArchiveWith<HashSet<T, H>>>::Archived>, )

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

impl Debug for AsVec

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

Formats the value using the given formatter.

impl<T, D> DeserializeWith<ArchivedVec<<T as Archive>::Archived>, BTreeSet<T>, D> for AsVec

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

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

Deserializes the field type F using the given deserializer.

impl<T, H, D> DeserializeWith<ArchivedVec<<T as Archive>::Archived>, HashSet<T, H>, D> for AsVec

where T: Archive + Hash + Eq, <T as Archive>::Archived: Deserialize<T, D>, H: BuildHasher + Default, D: Fallible + ?Sized,

fn deserialize_with( field: &ArchivedVec<<T as Archive>::Archived>, deserializer: &mut D, ) -> Result<HashSet<T, H>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<K, V, D> DeserializeWith<ArchivedVec<Entry<<K as Archive>::Archived, <V as Archive>::Archived>>, BTreeMap<K, V>, D> for AsVec

where K: Archive + Ord, V: Archive, <K as Archive>::Archived: Deserialize<K, D>, <V as Archive>::Archived: Deserialize<V, D>, D: Fallible + ?Sized,

fn deserialize_with( field: &ArchivedVec<Entry<<K as Archive>::Archived, <V as Archive>::Archived>>, deserializer: &mut D, ) -> Result<BTreeMap<K, V>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<K, V, H, D> DeserializeWith<ArchivedVec<Entry<<K as Archive>::Archived, <V as Archive>::Archived>>, HashMap<K, V, H>, D> for AsVec

where K: Archive + Hash + Eq, V: Archive, <K as Archive>::Archived: Deserialize<K, D>, <V as Archive>::Archived: Deserialize<V, D>, H: BuildHasher + Default, D: Fallible + ?Sized,

fn deserialize_with( field: &ArchivedVec<Entry<<K as Archive>::Archived, <V as Archive>::Archived>>, deserializer: &mut D, ) -> Result<HashMap<K, V, H>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<D, const A: usize> DeserializeWith<ArchivedVec<u8>, AlignedVec<A>, D> for AsVec

where D: Fallible + ?Sized,

fn deserialize_with( field: &ArchivedVec<u8>, _: &mut D, ) -> Result<AlignedVec<A>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<S, const A: usize> SerializeWith<AlignedVec<A>, S> for AsVec

where S: Allocator + Fallible + Writer + ?Sized,

fn serialize_with( field: &AlignedVec<A>, serializer: &mut S, ) -> Result<<AsVec as ArchiveWith<AlignedVec<A>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.

impl<K, V, S> SerializeWith<BTreeMap<K, V>, S> for AsVec

where K: Serialize<S>, V: Serialize<S>, S: Fallible + Allocator + Writer + ?Sized,

fn serialize_with( field: &BTreeMap<K, V>, serializer: &mut S, ) -> Result<<AsVec as ArchiveWith<BTreeMap<K, V>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.

impl<T, S> SerializeWith<BTreeSet<T>, S> for AsVec

where T: Serialize<S>, S: Fallible + Allocator + Writer + ?Sized,

fn serialize_with( field: &BTreeSet<T>, serializer: &mut S, ) -> Result<<AsVec as ArchiveWith<BTreeSet<T>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.

impl<K, V, H, S> SerializeWith<HashMap<K, V, H>, S> for AsVec

where K: Serialize<S>, V: Serialize<S>, S: Fallible + Allocator + Writer + ?Sized,

fn serialize_with( field: &HashMap<K, V, H>, serializer: &mut S, ) -> Result<<AsVec as ArchiveWith<HashMap<K, V, H>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.

impl<T, H, S> SerializeWith<HashSet<T, H>, S> for AsVec

where T: Serialize<S>, S: Fallible + Allocator + Writer + ?Sized,

fn serialize_with( field: &HashSet<T, H>, serializer: &mut S, ) -> Result<<AsVec as ArchiveWith<HashSet<T, H>>>::Resolver, <S as Fallible>::Error>

Serializes the field type F using the given serializer.