pub struct ScopeContext<'a> { /* private fields */ }Implementations§
Source§impl<'a> ScopeContext<'a>
impl<'a> ScopeContext<'a>
Sourcepub fn get_class_like(&self) -> Option<&'a ClassLikeMetadata>
pub fn get_class_like(&self) -> Option<&'a ClassLikeMetadata>
Returns the calling class-like context, if available.
Sourcepub fn get_class_like_name(&self) -> Option<&'a StringIdentifier>
pub fn get_class_like_name(&self) -> Option<&'a StringIdentifier>
Returns the calling class FQCN, if inside a class scope.
Sourcepub fn get_function_like(&self) -> Option<&'a FunctionLikeMetadata>
pub fn get_function_like(&self) -> Option<&'a FunctionLikeMetadata>
Returns the calling function-like context, if available.
Sourcepub fn get_function_like_identifier(&self) -> Option<FunctionLikeIdentifier>
pub fn get_function_like_identifier(&self) -> Option<FunctionLikeIdentifier>
Returns the identifier of the calling function/method, if available.
Sourcepub const fn is_class_like_final(&self) -> bool
pub const fn is_class_like_final(&self) -> bool
Checks if the calling class scope is marked as final.
Sourcepub fn set_function_like(
&mut self,
function_like: Option<&'a FunctionLikeMetadata>,
)
pub fn set_function_like( &mut self, function_like: Option<&'a FunctionLikeMetadata>, )
Sets the function-like metadata for the current scope.
Sourcepub fn set_class_like(&mut self, class_like: Option<&'a ClassLikeMetadata>)
pub fn set_class_like(&mut self, class_like: Option<&'a ClassLikeMetadata>)
Sets the class-like metadata for the current scope.
Sourcepub fn set_static(&mut self, is_static: bool)
pub fn set_static(&mut self, is_static: bool)
Sets the static flag for the current scope.
Sourcepub fn get_reference_source(&self) -> Option<ReferenceSource>
pub fn get_reference_source(&self) -> Option<ReferenceSource>
Determines the ReferenceSource (symbol or member) based on the current function context.
Used to identify the origin of a code reference for dependency tracking.
Trait Implementations§
Source§impl<'a> Clone for ScopeContext<'a>
impl<'a> Clone for ScopeContext<'a>
Source§fn clone(&self) -> ScopeContext<'a>
fn clone(&self) -> ScopeContext<'a>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'a> Debug for ScopeContext<'a>
impl<'a> Debug for ScopeContext<'a>
Source§impl Default for ScopeContext<'_>
impl Default for ScopeContext<'_>
Source§impl<'a> PartialEq for ScopeContext<'a>
impl<'a> PartialEq for ScopeContext<'a>
impl<'a> Copy for ScopeContext<'a>
impl<'a> Eq for ScopeContext<'a>
impl<'a> StructuralPartialEq for ScopeContext<'a>
Auto Trait Implementations§
impl<'a> Freeze for ScopeContext<'a>
impl<'a> RefUnwindSafe for ScopeContext<'a>
impl<'a> Send for ScopeContext<'a>
impl<'a> Sync for ScopeContext<'a>
impl<'a> Unpin for ScopeContext<'a>
impl<'a> UnwindSafe for ScopeContext<'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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.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);