Struct rkyv::with::AsString

pub struct AsString;

A wrapper that attempts to convert a type to and from UTF-8.

Types like OsString and PathBuf aren’t guaranteed to be encoded as UTF-8, but they usually are anyway. Using this wrapper will archive them as if they were regular Strings.

Regular serializers don’t support the custom error handling needed for this type by default. To use this wrapper, a custom serializer with an error type satisfying <S as Fallible>::Error: From<AsStringError> must be provided.

Example

use std::{ffi::OsString, path::PathBuf};
use rkyv::{Archive, with::AsString};

#[derive(Archive)]
struct Example {
    #[with(AsString)]
    os_string: OsString,
    #[with(AsString)]
    path: PathBuf,
}

Trait Implementations

impl ArchiveWith<OsString> for AsString

type Archived = ArchivedString

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

type Resolver = StringResolver

The resolver of a With<F, Self>.

unsafe fn resolve_with(
    field: &OsString,
    pos: usize,
    resolver: Self::Resolver,
    out: *mut Self::Archived
)

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

impl ArchiveWith<PathBuf> for AsString

type Archived = ArchivedString

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

type Resolver = StringResolver

The resolver of a With<F, Self>.

unsafe fn resolve_with(
    field: &PathBuf,
    pos: usize,
    resolver: Self::Resolver,
    out: *mut Self::Archived
)

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

impl Debug for AsString

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

Formats the value using the given formatter.

impl<D: Fallible + ?Sized> DeserializeWith<ArchivedString, OsString, D> for AsString

fn deserialize_with(
    field: &ArchivedString,
    _: &mut D
) -> Result<OsString, D::Error>

Deserializes the field type F using the given deserializer.

impl<D: Fallible + ?Sized> DeserializeWith<ArchivedString, PathBuf, D> for AsString

fn deserialize_with(
    field: &ArchivedString,
    _: &mut D
) -> Result<PathBuf, D::Error>

Deserializes the field type F using the given deserializer.

impl<S: Fallible + ?Sized> SerializeWith<OsString, S> for AsString where
    S::Error: From<AsStringError>,
    str: SerializeUnsized<S>, 

fn serialize_with(
    field: &OsString,
    serializer: &mut S
) -> Result<Self::Resolver, S::Error>

Serializes the field type F using the given serializer.

impl<S: Fallible + ?Sized> SerializeWith<PathBuf, S> for AsString where
    S::Error: From<AsStringError>,
    str: SerializeUnsized<S>, 

fn serialize_with(
    field: &PathBuf,
    serializer: &mut S
) -> Result<Self::Resolver, S::Error>

Serializes the field type F using the given serializer.