Skip to main content

ConstEvalCtxt

Struct ConstEvalCtxt 

Source
pub struct ConstEvalCtxt<'tcx> { /* private fields */ }
Expand description

The context required to evaluate a constant expression.

This is currently limited to constant folding and reading the value of named constants.

See the module level documentation for some context.

Implementations§

Source§

impl<'tcx> ConstEvalCtxt<'tcx>

Source

pub fn new(cx: &LateContext<'tcx>) -> Self

Creates the evaluation context from the lint context. This requires the lint context to be in a body (i.e. cx.enclosing_body.is_some()).

Source

pub fn with_env( tcx: TyCtxt<'tcx>, typing_env: TypingEnv<'tcx>, typeck: &'tcx TypeckResults<'tcx>, ) -> Self

Creates an evaluation context.

Source

pub fn eval_with_source( &self, e: &Expr<'_>, ctxt: SyntaxContext, ) -> Option<(Constant, ConstantSource)>

Attempts to evaluate the expression and returns both the value and whether it’s dependant on other items.

Source

pub fn eval(&self, e: &Expr<'_>) -> Option<Constant>

Attempts to evaluate the expression.

Source

pub fn eval_local(&self, e: &Expr<'_>, ctxt: SyntaxContext) -> Option<Constant>

Attempts to evaluate the expression without accessing other items.

The context argument is the context used to view the evaluated expression. e.g. when evaluating the argument in f(m!(1)) the context of the call expression should be used. This is need so the const evaluator can see the m macro and marke the evaluation as non-local independant of what the macro expands to.

Source

pub fn eval_full_int( &self, e: &Expr<'_>, ctxt: SyntaxContext, ) -> Option<FullInt>

Attempts to evaluate the expression as an integer without accessing other items.

The context argument is the context used to view the evaluated expression. e.g. when evaluating the argument in f(m!(1)) the context of the call expression should be used. This is need so the const evaluator can see the m macro and marke the evaluation as non-local independant of what the macro expands to.

Source

pub fn eval_pat_expr(&self, pat_expr: &PatExpr<'_>) -> Option<Constant>

Source

pub fn eval_is_empty(&self, e: &Expr<'_>) -> Option<bool>

Simple constant folding to determine if an expression is an empty slice, str, array, … None will be returned if the constness cannot be determined, or if the resolution leaves the local crate.

Auto Trait Implementations§

§

impl<'tcx> !Freeze for ConstEvalCtxt<'tcx>

§

impl<'tcx> !RefUnwindSafe for ConstEvalCtxt<'tcx>

§

impl<'tcx> !Send for ConstEvalCtxt<'tcx>

§

impl<'tcx> !Sync for ConstEvalCtxt<'tcx>

§

impl<'tcx> Unpin for ConstEvalCtxt<'tcx>

§

impl<'tcx> UnsafeUnpin for ConstEvalCtxt<'tcx>

§

impl<'tcx> !UnwindSafe for ConstEvalCtxt<'tcx>

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

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

Source§

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.