Struct miniscript::miniscript::types::correctness::Correctness

pub struct Correctness {
    pub base: Base,
    pub input: Input,
    pub dissatisfiable: bool,
    pub unit: bool,
}

Structure representing the type properties of a fragment which are relevant to completeness (are all expected branches actually accessible, given some valid witness) and soundness (is it possible to satisfy the Script without satisfying one of the Miniscript branches).

Fields

base: Base

The base type

input: Input

Properties of the inputs

dissatisfiable: bool

Whether it is definitely possible to dissatisfy the expression. If this is false, it does not necessarily mean that dissatisfaction is impossible (see Dissat::None for this property); it only means that we cannot depend on having a dissatisfaction when reasoning about completeness.

unit: bool

Whether the fragment’s “nonzero” output on satisfaction is always the constant 1.

Implementations

impl Correctness

pub const TRUE: Self = _

Correctness data for the 1 combinator

pub const FALSE: Self = _

Correctness data for the 0 combinator

pub const fn is_subtype(&self, other: Self) -> bool

Check whether the self is a subtype of other argument . This checks whether the argument other has attributes which are present in the given Type. This returns true on same arguments a.is_subtype(a) is true.

pub fn sanity_checks(&self)

Confirm invariants of the correctness checker.

pub const fn pk_k() -> Self

Constructor for the correctness properties of the pk_k fragment.

pub const fn pk_h() -> Self

Constructor for the correctness properties of the pk_h fragment.

pub const fn multi() -> Self

Constructor for the correctness properties of the multi fragment.

pub const fn multi_a() -> Self

Constructor for the correctness properties of the multi_a fragment.

pub const fn hash() -> Self

Constructor for the correctness properties of any of the hash fragments.

pub const fn time() -> Self

Constructor for the correctness properties of either of the time fragments.

pub const fn cast_alt(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the a: fragment.

pub const fn cast_swap(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the s: fragment.

pub const fn cast_check(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the c: fragment.

pub const fn cast_dupif(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the d: fragment.

pub const fn cast_verify(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the v: fragment.

pub const fn cast_nonzero(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the j: fragment.

pub const fn cast_zeronotequal(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the n: fragment.

pub const fn cast_true(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the t: fragment.

pub const fn cast_or_i_false(self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the l: and u: fragments.

pub const fn and_b(left: Self, right: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the and_b fragment

pub const fn and_v(left: Self, right: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the and_v fragment

pub const fn or_b(left: Self, right: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the or_b fragment

pub const fn or_d(left: Self, right: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the or_d fragment

pub const fn or_c(left: Self, right: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the or_c fragment

pub const fn or_i(left: Self, right: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the or_i fragment

pub const fn and_or(a: Self, b: Self, c: Self) -> Result<Self, ErrorKind>

Constructor for the correctness properties of the andor fragment

pub fn threshold<'a, I>(_k: usize, subs: I) -> Result<Self, ErrorKind>

where I: Iterator<Item = &'a Self>,

Constructor for the correctness properties of the thresh fragment

Trait Implementations

impl Clone for Correctness

fn clone(&self) -> Correctness

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Correctness

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

Formats the value using the given formatter.

impl Hash for Correctness

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 Correctness

fn cmp(&self, other: &Correctness) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Correctness

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

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

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

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

impl PartialOrd for Correctness

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Correctness

impl Eq for Correctness

impl StructuralPartialEq for Correctness