Struct chalk_ir::Goal

pub struct Goal<I: Interner> { /* fields omitted */ }

A general goal; this is the full range of questions you can pose to Chalk.

Implementations

impl<I: Interner> Goal<I>

pub fn new(interner: &I, interned: GoalData<I>) -> Self

Create a new goal using GoalData.

pub fn interned(&self) -> &I::InternedGoal

Gets the interned goal.

pub fn data(&self, interner: &I) -> &GoalData<I>

Gets the interned goal data.

pub fn quantify(
    self,
    interner: &I,
    kind: QuantifierKind,
    binders: VariableKinds<I>
) -> Goal<I>

Create a goal using a forall or exists quantifier.

pub fn negate(self, interner: &I) -> Self

Takes a goal G and turns it into not { G }.

pub fn compatible(self, interner: &I) -> Self

Takes a goal G and turns it into compatible { G }.

pub fn implied_by(self, interner: &I, predicates: ProgramClauses<I>) -> Goal<I>

Create an implication goal that holds if the predicates are true.

pub fn is_trivially_true(&self, interner: &I) -> bool

True if this goal is "trivially true" -- i.e., no work is required to prove it.

impl<I> Goal<I> where
    I: Interner, 

pub fn all<II>(interner: &I, iter: II) -> Self where
    II: IntoIterator<Item = Goal<I>>, 

Creates a single goal that only holds if a list of goals holds.

Trait Implementations

impl<I: Interner> CastTo<Goal<I>> for Goal<I>

pub fn cast_to(self, _interner: &<Goal<I> as HasInterner>::Interner) -> Goal<I>

Cast a value to type T.

impl<T, I: Interner> CastTo<Goal<I>> for T where
    T: CastTo<DomainGoal<I>>, 

pub fn cast_to(self, interner: &I) -> Goal<I>

Cast a value to type T.

impl<I: Interner> CastTo<Goal<I>> for EqGoal<I>

pub fn cast_to(self, interner: &I) -> Goal<I>

Cast a value to type T.

impl<I: Interner> CastTo<Goal<I>> for SubtypeGoal<I>

pub fn cast_to(self, interner: &I) -> Goal<I>

Cast a value to type T.

impl<I: Interner, T: HasInterner<Interner = I> + CastTo<Goal<I>>> CastTo<Goal<I>> for Binders<T>

pub fn cast_to(self, interner: &I) -> Goal<I>

Cast a value to type T.

impl<I: Clone + Interner> Clone for Goal<I> where
    I::InternedGoal: Clone, 

pub fn clone(&self) -> Goal<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Copy + Interner> Copy for Goal<I> where
    I::InternedGoal: Copy, 

impl<I: Interner> Debug for Goal<I>

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

Formats the value using the given formatter.

impl<I: Eq + Interner> Eq for Goal<I> where
    I::InternedGoal: Eq, 

impl<I: Interner> Fold<I> for Goal<I>

Folding a goal invokes the fold_goal callback (which will, by default, invoke super-fold).

type Result = Goal<I>

The type of value that will be produced once folding is done. Typically this is Self, unless Self contains borrowed values, in which case owned values are produced (for example, one can fold over a &T value where T: Fold, in which case you get back a T, not a &T).

pub fn fold_with<'i>(
    &self,
    folder: &mut dyn Folder<'i, I>,
    outer_binder: DebruijnIndex
) -> Fallible<Self::Result> where
    I: 'i, 

Apply the given folder folder to self; binders is the number of binders that are in scope when beginning the folder. Typically binders starts as 0, but is adjusted when we encounter Binders<T> in the IR or other similar constructs.

impl<I: Interner> HasInterner for Goal<I>

type Interner = I

The interner associated with the type.

impl<I: Hash + Interner> Hash for Goal<I> where
    I::InternedGoal: Hash, 

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<I: Ord + Interner> Ord for Goal<I> where
    I::InternedGoal: Ord, 

pub fn cmp(&self, other: &Goal<I>) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<I: PartialEq + Interner> PartialEq<Goal<I>> for Goal<I> where
    I::InternedGoal: PartialEq, 

pub fn eq(&self, other: &Goal<I>) -> bool

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

pub fn ne(&self, other: &Goal<I>) -> bool

This method tests for !=.

impl<I: PartialOrd + Interner> PartialOrd<Goal<I>> for Goal<I> where
    I::InternedGoal: PartialOrd, 

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

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

pub fn lt(&self, other: &Goal<I>) -> bool

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

pub fn le(&self, other: &Goal<I>) -> bool

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

pub fn gt(&self, other: &Goal<I>) -> bool

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

pub fn ge(&self, other: &Goal<I>) -> bool

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

impl<I: Interner> StructuralEq for Goal<I>

impl<I: Interner> StructuralPartialEq for Goal<I>

impl<I: Interner> SuperFold<I> for Goal<I>

Superfold folds recursively.

pub fn super_fold_with<'i>(
    &self,
    folder: &mut dyn Folder<'i, I>,
    outer_binder: DebruijnIndex
) -> Fallible<Self::Result> where
    I: 'i, 

Recursively folds the value.

impl<I: Interner> SuperVisit<I> for Goal<I>

pub fn super_visit_with<'i, B>(
    &self,
    visitor: &mut dyn Visitor<'i, I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B> where
    I: 'i, 

Recursively visits the type contents.

impl<I: Interner> Visit<I> for Goal<I>

pub fn visit_with<'i, B>(
    &self,
    visitor: &mut dyn Visitor<'i, I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B> where
    I: 'i, 

Apply the given visitor visitor to self; binders is the number of binders that are in scope when beginning the visitor. Typically binders starts as 0, but is adjusted when we encounter Binders<T> in the IR or other similar constructs.

impl<I: Interner> Zip<I> for Goal<I>

pub fn zip_with<'i, Z: Zipper<'i, I>>(
    zipper: &mut Z,
    variance: Variance,
    a: &Self,
    b: &Self
) -> Fallible<()> where
    I: 'i, 

Uses the zipper to walk through two values, ensuring that they match.