pub struct HookContext<'ctx, 'a> { /* private fields */ }Expand description
Context for hooks that provides mutable access to analysis state.
Unlike ProviderContext which is read-only, HookContext allows hooks
to modify the analysis state (expression types, variable types, assertions).
Implementations§
Source§impl<'ctx, 'a> HookContext<'ctx, 'a>
impl<'ctx, 'a> HookContext<'ctx, 'a>
Sourcepub fn codebase(&self) -> &'ctx CodebaseMetadata
pub fn codebase(&self) -> &'ctx CodebaseMetadata
Get access to the codebase metadata.
Sourcepub fn get_expression_type<T: HasSpan>(&self, expr: &T) -> Option<&TUnion>
pub fn get_expression_type<T: HasSpan>(&self, expr: &T) -> Option<&TUnion>
Get the type of an expression.
Sourcepub fn get_rc_expression_type<T: HasSpan>(
&self,
expr: &T,
) -> Option<&Rc<TUnion>>
pub fn get_rc_expression_type<T: HasSpan>( &self, expr: &T, ) -> Option<&Rc<TUnion>>
Get the type of an expression as an Rc.
Sourcepub fn scope(&self) -> &ScopeContext<'ctx>
pub fn scope(&self) -> &ScopeContext<'ctx>
Get the current scope context.
Sourcepub fn is_instance_of(&self, class: &str, parent: &str) -> bool
pub fn is_instance_of(&self, class: &str, parent: &str) -> bool
Check if a class is an instance of another class.
Sourcepub fn get_closure_metadata<'arena>(
&self,
expr: &Expression<'arena>,
) -> Option<&'ctx FunctionLikeMetadata>
pub fn get_closure_metadata<'arena>( &self, expr: &Expression<'arena>, ) -> Option<&'ctx FunctionLikeMetadata>
Get metadata for a closure expression.
Sourcepub fn get_class_like(&self, name: &Atom) -> Option<&ClassLikeMetadata>
pub fn get_class_like(&self, name: &Atom) -> Option<&ClassLikeMetadata>
Get metadata for a class-like by name.
Sourcepub fn current_class_name(&self) -> Option<Atom>
pub fn current_class_name(&self) -> Option<Atom>
Get the current class name if inside a class.
Sourcepub fn set_expression_type<T: HasSpan>(&mut self, expr: &T, ty: TUnion)
pub fn set_expression_type<T: HasSpan>(&mut self, expr: &T, ty: TUnion)
Set the type of an expression.
Sourcepub fn set_variable_type(&mut self, name: &str, ty: TUnion)
pub fn set_variable_type(&mut self, name: &str, ty: TUnion)
Set the type of a variable.
Sourcepub fn artifacts_mut(&mut self) -> &mut AnalysisArtifacts
pub fn artifacts_mut(&mut self) -> &mut AnalysisArtifacts
Get mutable access to the analysis artifacts.
Sourcepub fn block_context_mut(&mut self) -> &mut BlockContext<'ctx>
pub fn block_context_mut(&mut self) -> &mut BlockContext<'ctx>
Get mutable access to the block context.
Sourcepub fn block_context(&self) -> &BlockContext<'ctx>
pub fn block_context(&self) -> &BlockContext<'ctx>
Get immutable access to the block context.
Auto Trait Implementations§
impl<'ctx, 'a> !Freeze for HookContext<'ctx, 'a>
impl<'ctx, 'a> !RefUnwindSafe for HookContext<'ctx, 'a>
impl<'ctx, 'a> !Send for HookContext<'ctx, 'a>
impl<'ctx, 'a> !Sync for HookContext<'ctx, 'a>
impl<'ctx, 'a> Unpin for HookContext<'ctx, 'a>
impl<'ctx, 'a> !UnwindSafe for HookContext<'ctx, 'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);