Struct chalk_ir::Goal

pub struct Goal<I: Interner> {
    pub(crate) interned: I::InternedGoal,
}

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

Fields

interned: I::InternedGoal

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, T: HasInterner<Interner = I> + CastTo<Goal<I>>> CastTo<Goal<I>> for Binders<T>

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

Cast a value to type T.

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

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

Cast a value to type T.

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

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

Cast a value to type T.

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

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,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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,

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

where I::InternedGoal: Ord,

fn cmp(&self, other: &Goal<I>) -> 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<I: PartialEq + Interner> PartialEq for Goal<I>

where I::InternedGoal: PartialEq,

fn eq(&self, other: &Goal<I>) -> 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<I: PartialOrd + Interner> PartialOrd for Goal<I>

where I::InternedGoal: PartialOrd,

fn partial_cmp(&self, other: &Goal<I>) -> 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<I: Interner> TypeFoldable<I> for Goal<I>

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

fn try_fold_with<E>( self, folder: &mut dyn FallibleTypeFolder<I, Error = E>, outer_binder: DebruijnIndex, ) -> Result<Self, E>

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.

fn fold_with( self, folder: &mut dyn TypeFolder<I>, outer_binder: DebruijnIndex, ) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

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

Superfold folds recursively.

fn try_super_fold_with<E>( self, folder: &mut dyn FallibleTypeFolder<I, Error = E>, outer_binder: DebruijnIndex, ) -> Result<Self, E>

Recursively folds the value.

fn super_fold_with( self, folder: &mut dyn TypeFolder<I>, outer_binder: DebruijnIndex, ) -> Self

A convenient alternative to try_super_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_super_fold_with.

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

fn super_visit_with<B>( &self, visitor: &mut dyn TypeVisitor<I, BreakTy = B>, outer_binder: DebruijnIndex, ) -> ControlFlow<B>

Recursively visits the type contents.

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

fn visit_with<B>( &self, visitor: &mut dyn TypeVisitor<I, BreakTy = B>, outer_binder: DebruijnIndex, ) -> ControlFlow<B>

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>

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

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

impl<I: Copy + Interner> Copy for Goal<I>

where I::InternedGoal: Copy,

impl<I: Eq + Interner> Eq for Goal<I>

where I::InternedGoal: Eq,

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