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 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.

Trait Implementations

impl Clone for Correctness

pub fn clone(&self) -> Correctness

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Correctness

impl Debug for Correctness

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

Formats the value using the given formatter.

impl Eq for Correctness

impl Hash for Correctness

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Correctness

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Correctness> for Correctness

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

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

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

This method tests for !=.

impl PartialOrd<Correctness> for Correctness

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

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

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

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

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

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

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

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

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

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

impl Property for Correctness

pub fn sanity_checks(&self)

Any extra sanity checks/assertions that should be applied after typechecking

pub fn from_true() -> Self

Type property of the True fragment

pub fn from_false() -> Self

Type property of the False fragment

pub fn from_pk_k() -> Self

Type property of the PkK fragment

pub fn from_pk_h() -> Self

Type property of the PkH fragment

pub fn from_multi(_: usize, _: usize) -> Self

Type property of a Multi fragment

pub fn from_hash() -> Self

Type property of a hash fragment

pub fn from_time(_: u32) -> Self

Type property of a timelock

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

Cast using the Alt wrapper

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

Cast using the Swap wrapper

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

Cast using the Check wrapper

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

Cast using the DupIf wrapper

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

Cast using the Verify wrapper

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

Cast using the NonZero wrapper

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

Cast using the ZeroNotEqual wrapper

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

Cast by changing [X] to AndV([X], True)

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

Cast by changing [X] to or_i([X], 0) or or_i(0, [X])

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

Computes the type of an AndB fragment

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

Computes the type of an AndV fragment

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

Computes the type of an OrB fragment

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

Computes the type of an OrD fragment

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

Computes the type of an OrC fragment

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

Computes the type of an OrI fragment

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

Computes the type of an AndOr fragment

pub fn threshold<S>(
    k: usize,
    n: usize,
    mut sub_ck: S
) -> Result<Self, ErrorKind> where
    S: FnMut(usize) -> Result<Self, ErrorKind>, 

Computes the type of an Thresh fragment

pub fn from_sha256() -> Self

Type property of a Sha256 hash. Default implementation simply passes through to from_hash

pub fn from_hash256() -> Self

Type property of a Hash256 hash. Default implementation simply passes through to from_hash

pub fn from_ripemd160() -> Self

Type property of a Ripemd160 hash. Default implementation simply passes through to from_hash

pub fn from_hash160() -> Self

Type property of a Hash160 hash. Default implementation simply passes through to from_hash

pub fn from_after(t: u32) -> Self

Type property of a relative timelock. Default implementation simply passes through to from_time

pub fn from_older(t: u32) -> Self

Type property of an absolute timelock. Default implementation simply passes through to from_time

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

Cast by changing [X] to or_i([X], 0). Default implementation simply passes through to cast_or_i_false

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

Cast by changing [X] to or_i(0, [X]). Default implementation simply passes through to cast_or_i_false

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

Computes the type of an AndN fragment

pub fn type_check<Pk, Ctx, C>(
    fragment: &Terminal<Pk, Ctx>,
    mut child: C
) -> Result<Self, Error<Pk, Ctx>> where
    C: FnMut(usize) -> Option<Self>,
    Pk: MiniscriptKey,
    Ctx: ScriptContext, 

Compute the type of a fragment, given a function to look up the types of its children, if available and relevant for the given fragment

impl StructuralEq for Correctness

impl StructuralPartialEq for Correctness