Struct Predicate

pub struct Predicate {
    pub state_read: Vec<StateReadBytecode>,
    pub constraints: Vec<ConstraintBytecode>,
}

An individual predicate to be solved.

Fields

state_read: Vec<StateReadBytecode>

The programs that read state.

constraints: Vec<ConstraintBytecode>

The programs that check constraints.

Implementations

impl Predicate

pub const MAX_STATE_READS: usize = 255usize

Maximum number of state read programs of a predicate.

pub const MAX_STATE_READ_SIZE_BYTES: usize = 10_000usize

Maximum size of state read programs of a predicate in bytes.

pub const MAX_CONSTRAINTS: usize = 255usize

Maximum number of constraint check programs of a predicate.

pub const MAX_CONSTRAINT_SIZE_BYTES: usize = 10_000usize

Maximum size of constraint check programs of a predicate in bytes.

pub const MAX_BYTES: usize = 51_200usize

Maximum size of a predicate in bytes.

pub fn programs(&self) -> impl Iterator<Item = &[u8]>

Iterator over the programs in the predicate.

pub fn into_programs(self) -> impl Iterator<Item = Vec<u8>>

An owning Iterator over the programs in the predicate.

pub fn encoded_header(&self) -> Result<EncodedHeader, PredicateError>

Generate the encoding header for this predicate.

pub fn encode(&self) -> Result<impl Iterator<Item = u8> + '_, PredicateError>

Encode the predicate into a bytes iterator.

pub fn encoded_size(&self) -> usize

The size of the encoded predicate in bytes.

This uses usize::saturating_add to sum the lengths of the state read and constraint. This could lead to an incorrect size for a very large predicate. However, such a predicate would be invalid due to the size limits.

pub fn decode(bytes: &[u8]) -> Result<Self, DecodeError>

Decode a predicate from bytes.

pub fn check_predicate_bounds(&self) -> Result<(), PredicateError>

Check the predicate is within the limits of a valid predicate.

Trait Implementations

impl Clone for Predicate

fn clone(&self) -> Predicate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Predicate

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

Formats the value using the given formatter.

impl Default for Predicate

fn default() -> Predicate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Predicate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Predicate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Predicate

fn cmp(&self, other: &Predicate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Predicate

fn eq(&self, other: &Predicate) -> 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 PartialOrd for Predicate

fn partial_cmp(&self, other: &Predicate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Predicate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Predicate

impl StructuralPartialEq for Predicate