Struct dusk_cdf::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 DEFAULT: Self = _

Default preamble

pub const fn new() -> Self

Create a new preamble instance.

pub fn with_witnesses(&mut self, witnesses: usize) -> &mut Self

Set the witnesses count

pub fn with_constraints(&mut self, constraints: usize) -> &mut Self

Set the constraints count

pub fn with_config(&mut self, config: Config) -> &mut Self

Set the configuration parameters

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, idx: usize) -> usize

Cache starting position

Trait Implementations

impl Clone for Preamble

fn clone(&self) -> Preamble

Returns a copy 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 Default for Preamble

fn default() -> Self

Returns the “default value” for a type.

impl Element for Preamble

type Config = AtomicConfig

Configuration for the serialization and deserialization

fn zeroed() -> Self

A zeroed/default instance of the type.

fn len(_config: &Self::Config) -> usize

Serializable length

fn to_buffer(
    &self,
    _config: &Self::Config,
    context: &mut ContextUnit,
    buf: &mut [u8]
)

Write the type into the buffer.

fn try_from_buffer_in_place<S>(
    &mut self,
    config: &Self::Config,
    context: &mut Context<S>,
    buf: &[u8]
) -> Result<()> where
    S: Read + Seek, 

Deserialize the type from a given buffer

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

Perform the internal validations of the associated element

fn validate_buffer_len(config: &Self::Config, len: usize) -> Result<()>

Assert the buffer is big enough to store the type

fn to_vec(&self, config: &Self::Config, context: &mut ContextUnit) -> Vec<u8>

Serialize the object into a bytes array.

fn try_from_buffer<S>(
    config: &Self::Config,
    context: &mut Context<S>,
    buf: &[u8]
) -> Result<Self> where
    S: Read + Seek, 

Create a new instance of the type from the provided buffer

fn try_decode_in_place<'a, S>(
    &mut self,
    config: &Self::Config,
    context: &mut Context<S>,
    buf: &'a [u8]
) -> Result<&'a [u8]> where
    S: Read + Seek, 

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

fn try_decode<'a, S>(
    config: &Self::Config,
    context: &mut Context<S>,
    buf: &'a [u8]
) -> Result<(Self, &'a [u8])> where
    S: Read + Seek, 

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

fn encode<'a>(
    &self,
    config: &Self::Config,
    context: &mut ContextUnit,
    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,
    config: &Self::Config,
    context: &mut ContextUnit
) -> Result<usize> where
    W: Write, 

Send the bytes representation of an element to a writer

fn try_from_context<S>(
    config: &Self::Config,
    context: &mut Context<S>
) -> Result<Self> where
    S: Read + Seek, 

Fetch a new element from a context

impl PartialEq<Preamble> for Preamble

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Preamble

impl Eq for Preamble

impl StructuralEq for Preamble

impl StructuralPartialEq for Preamble