pub struct Raw;
Expand description
A wrapper that provides an optimized bulk data array. This is primarily intended for large amounts of raw data, like bytes, floats, or integers.
This wrapper can be used with containers like Vec
, but care must be taken to ensure that they
contain copy-safe types. Copy-safe types must be trivially copyable (have the same archived and
unarchived representations) and contain no padding bytes. In situations where copying
uninitialized bytes the output is acceptable, this wrapper may be used with containers of types
that contain padding bytes.
Unlike CopyOptimize
, this wrapper will also skip validation for its elements. If the
elements of the container can have any invalid bit patterns (e.g. char
, bool
, complex
containers, etc.), then using Raw
in an insecure setting can lead to undefined behavior. Take
great caution!
Safety
Using this wrapper with containers containing non-copy-safe types or types that require validation may result in undefined behavior.
Example
use rkyv::{Archive, with::Raw};
#[derive(Archive)]
struct Example {
#[with(Raw)]
bytes: Vec<u8>,
#[with(Raw)]
vertices: Vec<[f32; 3]>,
}
Trait Implementations
sourceimpl<T: Archive> ArchiveWith<Vec<T, Global>> for Raw
impl<T: Archive> ArchiveWith<Vec<T, Global>> for Raw
type Archived = RawArchivedVec<T::Archived>
type Archived = RawArchivedVec<T::Archived>
The archived type of a With<F, Self>
.
type Resolver = VecResolver
type Resolver = VecResolver
The resolver of a With<F, Self>
.
sourceimpl<T, D> DeserializeWith<ArchivedVec<<T as Archive>::Archived>, Vec<T, Global>, D> for Raw where
T: Archive,
T::Archived: Deserialize<T, D>,
D: Fallible + ?Sized,
impl<T, D> DeserializeWith<ArchivedVec<<T as Archive>::Archived>, Vec<T, Global>, D> for Raw where
T: Archive,
T::Archived: Deserialize<T, D>,
D: Fallible + ?Sized,
sourcefn deserialize_with(
field: &ArchivedVec<T::Archived>,
_: &mut D
) -> Result<Vec<T>, D::Error>
fn deserialize_with(
field: &ArchivedVec<T::Archived>,
_: &mut D
) -> Result<Vec<T>, D::Error>
Deserializes the field type F
using the given deserializer.
sourceimpl<T, S> SerializeWith<Vec<T, Global>, S> for Raw where
T: Serialize<S>,
S: Serializer,
impl<T, S> SerializeWith<Vec<T, Global>, S> for Raw where
T: Serialize<S>,
S: Serializer,
Auto Trait Implementations
impl RefUnwindSafe for Raw
impl Send for Raw
impl Sync for Raw
impl Unpin for Raw
impl UnwindSafe for Raw
Blanket Implementations
sourceimpl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
sourcefn pointer_metadata(_: &Self::ArchivedMetadata) -> <Self as Pointee>::Metadata
fn pointer_metadata(_: &Self::ArchivedMetadata) -> <Self as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more