Struct chalk_ir::Goal

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

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

Fields§

§interned: I::InternedGoal

Implementations§

source§

impl<I: Interner> Goal<I>

source

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

Create a new goal using GoalData.

source

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

Gets the interned goal.

source

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

Gets the interned goal data.

source

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

Create a goal using a forall or exists quantifier.

source

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

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

source

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

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

source

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

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

source

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.

source§

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

source

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§

source§

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

source§

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

Cast a value to type T.
source§

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

source§

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

Cast a value to type T.
source§

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

source§

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

Cast a value to type T.
source§

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

source§

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

Cast a value to type T.
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Interner = I

The interner associated with the type.
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

fn cmp(&self, other: &Goal<I>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

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

source§

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

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

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

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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

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

source§

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

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

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

Superfold folds recursively.

source§

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

Recursively folds the value.
source§

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

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

source§

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

Recursively visits the type contents.
source§

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

source§

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

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

source§

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

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<I> RefUnwindSafe for Goal<I>

§

impl<I> Send for Goal<I>
where <I as Interner>::InternedGoal: Send,

§

impl<I> Sync for Goal<I>
where <I as Interner>::InternedGoal: Sync,

§

impl<I> Unpin for Goal<I>
where <I as Interner>::InternedGoal: Unpin,

§

impl<I> UnwindSafe for Goal<I>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Cast for T

source§

fn cast<U>(self, interner: U::Interner) -> U
where Self: CastTo<U>, U: HasInterner,

Cast a value to type U using CastTo.
source§

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

source§

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

Cast a value to type T.
source§

impl<T, I> CouldMatch<T> for T
where T: Zip<I> + HasInterner<Interner = I> + ?Sized, I: Interner,

source§

fn could_match( &self, interner: I, db: &dyn UnificationDatabase<I>, other: &T ) -> bool

Checks whether self and other could possibly match.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, I> Shift<I> for T
where T: TypeFoldable<I>, I: Interner,

source§

fn shifted_in(self, interner: I) -> T

Shifts this term in one level of binders.
source§

fn shifted_in_from(self, interner: I, source_binder: DebruijnIndex) -> T

Shifts a term valid at outer_binder so that it is valid at the innermost binder. See DebruijnIndex::shifted_in_from for a detailed explanation.
source§

fn shifted_out_to( self, interner: I, target_binder: DebruijnIndex ) -> Result<T, NoSolution>

Shifts a term valid at the innermost binder so that it is valid at outer_binder. See DebruijnIndex::shifted_out_to for a detailed explanation.
source§

fn shifted_out(self, interner: I) -> Result<T, NoSolution>

Shifts this term out one level of binders.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, I> VisitExt<I> for T
where I: Interner, T: TypeVisitable<I>,

source§

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

Check whether there are free (non-bound) variables.