Skip to main content

EncodedPayload

Struct EncodedPayload 

Source
pub struct EncodedPayload { /* private fields */ }
Expand description

EncodedPayload represents a payload that has had an encoding applied to it.

Encoding Format:

The encoded payload consists of two parts:

  1. Header (32 bytes):

    • Byte 0: Always 0x00 (reserved)
    • Byte 1: Encoding Version byte (e.g., 0x00 for PayloadEncodingVersion::Zero)
    • Bytes 2-5: Big-endian u32 representing the original payload length
    • Bytes 6-31: Reserved (filled with 0x00)
  2. Data (multiple of 32 bytes): Each 32-byte chunk contains:

    • Byte 0: 0x00 (padding byte to ensure the data is in valid field element range)
    • Bytes 1-31: 31 bytes of actual payload data (or padding for the last chunk)

The padding ensures that all data is compatible with the bn254 curve’s field element limitations, as each 32-byte segment represents a field element.

Implementations§

Source§

impl EncodedPayload

Source

pub fn new(payload: &Payload) -> Result<EncodedPayload, ConversionError>

Creates a new EncodedPayload from a Payload, performing the PayloadEncodingVersion0 encoding.

Source

pub fn decode(&self) -> Result<Payload, ConversionError>

Decodes the EncodedPayload back into a Payload.

Source

pub fn to_field_elements(&self) -> Vec<Fr>

Converts the encoded payload to an array of field elements.

Source

pub fn from_field_elements( field_elements: &[Fr], max_payload_length: usize, ) -> Result<EncodedPayload, ConversionError>

Creates an EncodedPayload from an array of field elements. max_payload_length is the maximum length in bytes that the contained Payload is permitted to be.

Trait Implementations§

Source§

impl Debug for EncodedPayload

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for EncodedPayload

Source§

fn eq(&self, other: &EncodedPayload) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for EncodedPayload

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V