Struct 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.

Example

use std::{ffi::OsString, path::PathBuf};

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

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

Trait Implementations

impl ArchiveWith<OsString> for AsString

Available on crate feature std only.

type Archived = ArchivedString

The archived type of Self with F.

type Resolver = StringResolver

The resolver of a Self with F.

fn resolve_with( field: &OsString, resolver: Self::Resolver, out: Place<Self::Archived>, )

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

impl ArchiveWith<PathBuf> for AsString

Available on crate feature std only.

type Archived = ArchivedString

The archived type of Self with F.

type Resolver = StringResolver

The resolver of a Self with F.

fn resolve_with( field: &PathBuf, resolver: Self::Resolver, out: Place<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> DeserializeWith<ArchivedString, OsString, D> for AsString

where D: Fallible + ?Sized,

Available on crate feature std only.

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

Deserializes the field type F using the given deserializer.

impl<D> DeserializeWith<ArchivedString, PathBuf, D> for AsString

where D: Fallible + ?Sized,

Available on crate feature std only.

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

Deserializes the field type F using the given deserializer.

impl<S> SerializeWith<OsString, S> for AsString

where S: Fallible + ?Sized, S::Error: Source, str: SerializeUnsized<S>,

Available on crate feature std only.

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

Serializes the field type F using the given serializer.

impl<S> SerializeWith<PathBuf, S> for AsString

where S: Fallible + ?Sized, S::Error: Source, str: SerializeUnsized<S>,

Available on crate feature std only.

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

Serializes the field type F using the given serializer.