Trait PackedValue

pub unsafe trait PackedValue:
    'static
    + Copy
    + Send
    + Sync {
    type Value: Packable;

    const WIDTH: usize;

    // Required methods
    fn from_slice(slice: &[Self::Value]) -> &Self;
    fn from_slice_mut(slice: &mut [Self::Value]) -> &mut Self;
    fn from_fn<F>(f: F) -> Self
       where F: FnMut(usize) -> Self::Value;
    fn as_slice(&self) -> &[Self::Value];
    fn as_slice_mut(&mut self) -> &mut [Self::Value];

    // Provided methods
    fn pack_slice(buf: &[Self::Value]) -> &[Self] { ... }
    fn pack_slice_with_suffix(buf: &[Self::Value]) -> (&[Self], &[Self::Value]) { ... }
    fn pack_slice_mut(buf: &mut [Self::Value]) -> &mut [Self] { ... }
    fn pack_maybe_uninit_slice_mut(
        buf: &mut [MaybeUninit<Self::Value>],
    ) -> &mut [MaybeUninit<Self>] { ... }
    fn pack_slice_with_suffix_mut(
        buf: &mut [Self::Value],
    ) -> (&mut [Self], &mut [Self::Value]) { ... }
    fn pack_maybe_uninit_slice_with_suffix_mut(
        buf: &mut [MaybeUninit<Self::Value>],
    ) -> (&mut [MaybeUninit<Self>], &mut [MaybeUninit<Self::Value>]) { ... }
    fn unpack_slice(buf: &[Self]) -> &[Self::Value] { ... }
}

Safety

• If P implements PackedField then P must be castable to/from [P::Value; P::WIDTH] without UB.

Required Associated Constants

const WIDTH: usize

Required Associated Types

type Value: Packable

Required Methods

fn from_slice(slice: &[Self::Value]) -> &Self

fn from_slice_mut(slice: &mut [Self::Value]) -> &mut Self

fn from_fn<F>(f: F) -> Self

where F: FnMut(usize) -> Self::Value,

Similar to core:array::from_fn.

fn as_slice(&self) -> &[Self::Value]

fn as_slice_mut(&mut self) -> &mut [Self::Value]

Provided Methods

fn pack_slice(buf: &[Self::Value]) -> &[Self]

fn pack_slice_with_suffix(buf: &[Self::Value]) -> (&[Self], &[Self::Value])

fn pack_slice_mut(buf: &mut [Self::Value]) -> &mut [Self]

fn pack_maybe_uninit_slice_mut( buf: &mut [MaybeUninit<Self::Value>], ) -> &mut [MaybeUninit<Self>]

fn pack_slice_with_suffix_mut( buf: &mut [Self::Value], ) -> (&mut [Self], &mut [Self::Value])

fn pack_maybe_uninit_slice_with_suffix_mut( buf: &mut [MaybeUninit<Self::Value>], ) -> (&mut [MaybeUninit<Self>], &mut [MaybeUninit<Self::Value>])

fn unpack_slice(buf: &[Self]) -> &[Self::Value]

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: Packable, const WIDTH: usize> PackedValue for [T; WIDTH]

const WIDTH: usize = WIDTH

type Value = T

fn from_slice(slice: &[Self::Value]) -> &Self

fn from_slice_mut(slice: &mut [Self::Value]) -> &mut Self

fn from_fn<F>(f: F) -> Self

where F: FnMut(usize) -> Self::Value,

fn as_slice(&self) -> &[Self::Value]

fn as_slice_mut(&mut self) -> &mut [Self::Value]

Implementors

impl<F: Field, const N: usize> PackedValue for FieldArray<F, N>

const WIDTH: usize = N

type Value = F

impl<T: Packable> PackedValue for T

const WIDTH: usize = 1usize

type Value = T