logo
pub struct AsString;
Expand description

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

The archived type of a With<F, Self>.
The resolver of a With<F, Self>.
Resolves the archived type using a reference to the field type F. Read more
The archived type of a With<F, Self>.
The resolver of a With<F, Self>.
Resolves the archived type using a reference to the field type F. Read more
Formats the value using the given formatter. Read more
Deserializes the field type F using the given deserializer.
Deserializes the field type F using the given deserializer.
Serializes the field type F using the given serializer.
Serializes the field type F using the given serializer.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
The archived version of the pointer metadata for this type.
Converts some archived metadata to the pointer metadata for itself.
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Deserializes using the given deserializer

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type for metadata in pointers and references to Self.
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.