Struct Place

pub struct Place<T>
where
    T: ?Sized,
{ /* private fields */ }

Available on crate feature dep_rkyv only.

A place to write a T paired with its position in the output buffer.

Implementations

impl<T> Place<T>

where T: ?Sized,

pub unsafe fn new_unchecked(pos: usize, ptr: *mut T) -> Place<T>

Creates a new Place from an output pointer.

Safety

ptr must be properly aligned, dereferenceable, and all of its bytes must be initialized.

pub unsafe fn from_field_unchecked<U>(parent: Place<U>, ptr: *mut T) -> Place<T>

where U: ?Sized,

Creates a new Place from a parent pointer and the field the place points to.

Safety

• ptr must point to a field of parent
• ptr must be properly aligned, dereferenceable, and all of its bytes must be initialized

pub fn pos(&self) -> usize

Returns the position of the place.

pub unsafe fn ptr(&self) -> *mut T

Returns the pointer associated with this place.

Safety

Uninitialized bytes must not be written to the returned pointer.

pub unsafe fn write_unchecked(&self, value: T)

Writes the provided value to this place.

Safety

value must not have any uninitialized bytes (e.g. padding).

pub fn write(&self, value: T)

where T: NoUndef,

Writes the provided value to this place.

pub unsafe fn cast_unchecked<U>(&self) -> Place<U>

Returns this place casted to the given type.

Safety

This place must point to a valid U.

pub fn as_slice(&self) -> &[u8]

where T: LayoutRaw,

Returns a slice of the bytes this place points to.

impl<T> Place<[T]>

pub unsafe fn index(&self, i: usize) -> Place<T>

Gets a Place to the i-th element of the slice.

Safety

i must be in-bounds for the slice pointed to by this place.

impl<T, const N: usize> Place<[T; N]>

pub unsafe fn index(&self, i: usize) -> Place<T>

Gets a Place to the i-th element of the array.

Safety

i must be in-bounds for the array pointed to by this place.

Trait Implementations

impl<T> Clone for Place<T>

where T: ?Sized,

fn clone(&self) -> Place<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Destructure for Place<T>

where T: ?Sized,

type Underlying = T

The underlying type that is destructured.

type Destructuring = Borrow

The type of destructuring to perform.

fn underlying(&mut self) -> *mut <Place<T> as Destructure>::Underlying

Returns a mutable pointer to the underlying type.

impl<T, U> Restructure<U> for Place<T>

where T: ?Sized, U: ?Sized,

type Restructured = Place<U>

The restructured version of this type.

unsafe fn restructure( &self, ptr: *mut U, ) -> <Place<T> as Restructure<U>>::Restructured

Restructures a pointer to this type into the target type.

impl<T> Copy for Place<T>

where T: ?Sized,