Struct Preamble 

pub struct Preamble {
    pub witnesses: usize,
    pub constraints: usize,
    pub config: Config,
}

Metadata information of the CDF file

Fields

witnesses: usize

Witnesses count

constraints: usize

Constraints count

config: Config

Configuration parameters for encoding and decoding

Implementations

impl Preamble

pub const LEN: usize = 17usize

Serialized length

pub const fn new(witnesses: usize, constraints: usize, config: Config) -> Self

Create a new preamble instance

pub fn witness_offset(&self, idx: usize) -> Option<usize>

Witness offset in CDF, from an index

pub fn constraint_offset(&self, idx: usize) -> Option<usize>

Constraint offset in CDF, from an index

pub fn source_cache_offset(&self) -> usize

Cache starting position

Trait Implementations

impl Clone for Preamble

fn clone(&self) -> Preamble

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Preamble

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

Formats the value using the given formatter.

impl DecodableElement for Preamble

fn try_from_buffer_in_place<'a, 'b>( &'a mut self, ctx: &DecoderContext<'a>, buf: &'b [u8], ) -> Result<()>

Deserialize the type from a given buffer

fn try_from_buffer<'b>(ctx: &DecoderContext<'_>, buf: &'b [u8]) -> Result<Self>

Create a new instance of the type from the provided buffer

fn try_decode_in_place<'a, 'b>( &mut self, ctx: &DecoderContext<'a>, buf: &'b [u8], ) -> Result<&'b [u8]>

Write an element from the buffer, and return the remainder bytes

fn try_decode<'a, 'b>( ctx: &DecoderContext<'a>, buf: &'b [u8], ) -> Result<(Self, &'b [u8])>

Write an element from the buffer, and return the remainder bytes

fn try_from_reader<R>(ctx: &DecoderContext<'_>, reader: R) -> Result<Self>

where R: Read,

Fetch a new element from a context

impl Default for Preamble

fn default() -> Self

Returns the “default value” for a type.

impl Element for Preamble

fn len(ctx: &Config) -> usize

Serializable length

fn validate(&self, preamble: &Preamble) -> Result<()>

Perform the internal validations of the associated element

fn validate_buffer(config: &Config, buffer: &[u8]) -> Result<()>

Assert the buffer is big enough to store the type

impl EncodableElement for Preamble

fn to_buffer(&self, ctx: &mut EncoderContext, buf: &mut [u8])

Write the type into the buffer.

fn to_vec(&self, ctx: &mut EncoderContext) -> Vec<u8>

Serialize the object into a bytes array.

fn encode<'a>( &self, ctx: &mut EncoderContext, buf: &'a mut [u8], ) -> &'a mut [u8]

Read an element into the buffer, returning the remainder bytes

fn try_to_writer<W>(&self, writer: W, ctx: &mut EncoderContext) -> Result<usize>

where W: Write,

Send the bytes representation of an element to a writer

impl PartialEq for Preamble

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Preamble

impl Eq for Preamble

impl StructuralPartialEq for Preamble