Struct chalk_ir::Goal[][src]

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

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

Implementations

impl<I: Interner> Goal<I>[src]

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

Create a new goal using GoalData.

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

Gets the interned goal.

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

Gets the interned goal data.

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

Create a goal using a forall or exists quantifier.

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

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

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

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

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

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

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

True if this goal is “trivially true” – i.e., no work is required to prove it.

impl<I> Goal<I> where
    I: Interner
[src]

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

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

Trait Implementations

impl<I: Interner> CastTo<Goal<I>> for Goal<I>[src]

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

Cast a value to type T.

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

fn cast_to(self, interner: &I) -> Goal<I>[src]

Cast a value to type T.

impl<I: Interner> CastTo<Goal<I>> for EqGoal<I>[src]

fn cast_to(self, interner: &I) -> Goal<I>[src]

Cast a value to type T.

impl<I: Interner> CastTo<Goal<I>> for SubtypeGoal<I>[src]

fn cast_to(self, interner: &I) -> Goal<I>[src]

Cast a value to type T.

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

fn cast_to(self, interner: &I) -> Goal<I>[src]

Cast a value to type T.

impl<I: Clone + Interner> Clone for Goal<I> where
    I::InternedGoal: Clone
[src]

fn clone(&self) -> Goal<I>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<I: Interner> Debug for Goal<I>[src]

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

Formats the value using the given formatter. Read more

impl<I: Interner> Fold<I> for Goal<I>[src]

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). Read more

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

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

impl<I: Interner> HasInterner for Goal<I>[src]

type Interner = I

The interner associated with the type.

impl<I: Hash + Interner> Hash for Goal<I> where
    I::InternedGoal: Hash
[src]

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

Feeds this value into the given Hasher. Read more

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

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

impl<I: Ord + Interner> Ord for Goal<I> where
    I::InternedGoal: Ord
[src]

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

This method returns an Ordering between self and other. Read more

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

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

Restrict a value to a certain interval. Read more

impl<I: PartialEq + Interner> PartialEq<Goal<I>> for Goal<I> where
    I::InternedGoal: PartialEq
[src]

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

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

fn ne(&self, other: &Goal<I>) -> bool[src]

This method tests for !=.

impl<I: PartialOrd + Interner> PartialOrd<Goal<I>> for Goal<I> where
    I::InternedGoal: PartialOrd
[src]

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

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl<I: Interner> SuperFold<I> for Goal<I>[src]

Superfold folds recursively.

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

Recursively folds the value.

impl<I: Interner> SuperVisit<I> for Goal<I>[src]

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

Recursively visits the type contents.

impl<I: Interner> Visit<I> for Goal<I>[src]

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

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

impl<I: Interner> Zip<I> for Goal<I>[src]

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

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

impl<I: Copy + Interner> Copy for Goal<I> where
    I::InternedGoal: Copy
[src]

impl<I: Eq + Interner> Eq for Goal<I> where
    I::InternedGoal: Eq
[src]

impl<I: Interner> StructuralEq for Goal<I>[src]

impl<I: Interner> StructuralPartialEq for Goal<I>[src]

Auto Trait Implementations

impl<I> RefUnwindSafe for Goal<I> where
    <I as Interner>::InternedGoal: RefUnwindSafe

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> where
    <I as Interner>::InternedGoal: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Cast for T[src]

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

Cast a value to type U using CastTo.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn cast_to(Self, &I) -> Goal<I>[src]

Cast a value to type T.

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

pub fn could_match(&Self, &I, &dyn UnificationDatabase<I>, &T) -> bool[src]

Checks whether self and other could possibly match.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, I> Shift<I> for T where
    T: Fold<I>,
    I: Interner
[src]

pub fn shifted_in(Self, &I) -> <T as Fold<I>>::Result[src]

Shifts this term in one level of binders.

pub fn shifted_in_from(Self, &I, DebruijnIndex) -> <T as Fold<I>>::Result[src]

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

pub fn shifted_out_to(
    Self,
    &I,
    DebruijnIndex
) -> Result<<T as Fold<I>>::Result, NoSolution>
[src]

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

pub fn shifted_out(Self, &I) -> Result<<T as Fold<I>>::Result, NoSolution>[src]

Shifts this term out one level of binders.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, I> VisitExt<I> for T where
    T: Visit<I>,
    I: Interner
[src]

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

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