Skip to main content

PluginRegistry

mago_analyzer::plugin::registry

Struct PluginRegistry 

Source 
pub struct PluginRegistry { /* private fields */ }

Implementations§

Source§

impl PluginRegistry

Source

pub fn set_external_analyzer(&mut self, analyzer: Arc<ExternalAnalyzerHandle>)

Attaches worker-backed analyzer plugins to this registry.

Source

pub fn prepare_external_analyzer(&self) -> PluginResult<()>

Completes concurrent external analyzer initialization before file analysis.

§Errors

Returns an error when a worker fails to initialize or advertises invalid capabilities.

Source

pub fn external_initialization_files(&self) -> PluginResult<Vec<File>>

Completes external initialization and returns its in-memory source stubs.

§Errors

Returns an error when a worker fails to initialize or returns invalid initialization data.

Source

pub fn external_codebase_scan_plan( &self, ) -> PluginResult<Option<CodebaseScanPlan>>

Returns compiled host-file selectors for enabled external codebase-scan hooks.

§Errors

Returns an error when the external analyzer cannot initialize or a hook advertises an invalid path pattern.

Source

pub fn run_external_codebase_scan( &self, files: Vec<CodebaseScanFile>, ) -> PluginResult<()>

Replaces each external worker’s selected codebase-scan source state.

§Errors

Returns an error when a worker cannot accept or validate the snapshot sequence.

Source

pub fn create_external_analysis_session( &self, files: impl IntoIterator<Item = Arc<File>>, ) -> Option<ExternalAnalysisSession>

Creates the immutable external-plugin context for one frozen codebase generation.

Source

pub fn has_external_after_file_analysis_hooks(&self) -> PluginResult<bool>

Returns whether any enabled external plugin subscribed to per-file completion.

§Errors

Returns an error when the external analyzer cannot be initialized.

Source

pub fn external_node_analysis_requirements( &self, ) -> PluginResult<Option<NodeAnalysisRequirements>>

Returns the syntax targets and embedded data requested by enabled external analyzer hooks.

§Errors

Returns an error when the external analyzer cannot be initialized.

Source

pub fn has_external_after_analysis_hooks(&self) -> PluginResult<bool>

Returns whether any enabled external plugin subscribed to whole-project completion.

§Errors

Returns an error when the external analyzer cannot be initialized.

Source

pub fn run_external_before_analysis_hooks( &self, codebase: &CodebaseMetadata, session: Option<&ExternalAnalysisSession>, ) -> PluginResult<BeforeAnalysisResult>

Runs enabled external hooks after the codebase is frozen and before file analysis starts.

§Errors

Returns an error when an external hook cannot be dispatched or returns an invalid response.

Source

pub fn run_external_after_file_analysis_hooks( &self, file: &File, program: &Program<'_>, resolved_names: &ResolvedNames<'_>, artifacts: &AnalysisArtifacts, codebase: &CodebaseMetadata, session: Option<&ExternalAnalysisSession>, ) -> PluginResult<AfterFileAnalysisResult>

Runs enabled external hooks for one completed file analysis.

§Errors

Returns an error when an external hook cannot be dispatched or returns an invalid response.

Source

pub fn run_external_after_file_analysis_batch_hooks( &self, files: &[Arc<FileAnalysisSnapshot>], codebase: &CodebaseMetadata, session: Option<&ExternalAnalysisSession>, ) -> PluginResult<AfterFileAnalysisResult>

Runs enabled external after-file hooks for a batch of completed analyses.

§Errors

Returns an error when an external hook cannot be dispatched or returns an invalid response.

Source

pub fn run_external_after_analysis_hooks( &self, result: &AnalysisResult, files: &[Arc<FileAnalysisSnapshot>], codebase: &CodebaseMetadata, session: Option<&ExternalAnalysisSession>, ) -> PluginResult<IssueCollection>

Runs enabled external hooks for the final merged analysis result.

§Errors

Returns an error when an external hook cannot be dispatched or returns an invalid response.

Source

pub fn new() -> Self

Source

pub fn with_library_providers() -> Self

Source

pub fn register_function_provider<P>(&mut self, provider: P)
where P: FunctionReturnTypeProvider + 'static,

Source

pub fn register_method_provider<P>(&mut self, provider: P)
where P: MethodReturnTypeProvider + 'static,

Source

pub fn register_program_hook<H>(&mut self, hook: H)
where H: ProgramHook + 'static,

Source

pub fn register_statement_hook<H>(&mut self, hook: H)
where H: StatementHook + 'static,

Source

pub fn register_expression_hook<H>(&mut self, hook: H)
where H: ExpressionHook + 'static,

Source

pub fn register_function_call_hook<H>(&mut self, hook: H)
where H: FunctionCallHook + 'static,

Source

pub fn register_method_call_hook<H>(&mut self, hook: H)
where H: MethodCallHook + 'static,

Source

pub fn register_static_method_call_hook<H>(&mut self, hook: H)
where H: StaticMethodCallHook + 'static,

Source

pub fn register_nullsafe_method_call_hook<H>(&mut self, hook: H)
where H: NullSafeMethodCallHook + 'static,

Source

pub fn register_class_hook<H>(&mut self, hook: H)
where H: ClassDeclarationHook + 'static,

Source

pub fn register_interface_hook<H>(&mut self, hook: H)
where H: InterfaceDeclarationHook + 'static,

Source

pub fn register_trait_hook<H>(&mut self, hook: H)
where H: TraitDeclarationHook + 'static,

Source

pub fn register_enum_hook<H>(&mut self, hook: H)
where H: EnumDeclarationHook + 'static,

Source

pub fn register_function_decl_hook<H>(&mut self, hook: H)
where H: FunctionDeclarationHook + 'static,

Source

pub fn register_property_initialization_provider<P>(&mut self, provider: P)
where P: PropertyInitializationProvider + 'static,

Source

pub fn register_issue_filter_hook<H>(&mut self, hook: H)
where H: IssueFilterHook + 'static,

Source

pub fn register_function_assertion_provider<P>(&mut self, provider: P)
where P: FunctionAssertionProvider + 'static,

Source

pub fn register_method_assertion_provider<P>(&mut self, provider: P)
where P: MethodAssertionProvider + 'static,

Source

pub fn register_expression_throw_provider<P>(&mut self, provider: P)
where P: ExpressionThrowTypeProvider + 'static,

Source

pub fn register_function_throw_provider<P>(&mut self, provider: P)
where P: FunctionThrowTypeProvider + 'static,

Source

pub fn register_method_throw_provider<P>(&mut self, provider: P)
where P: MethodThrowTypeProvider + 'static,

Source

pub fn has_program_hooks(&self) -> bool

Source

pub fn has_statement_hooks(&self) -> bool

Source

pub fn has_expression_hooks(&self) -> bool

Source

pub fn has_function_call_hooks(&self) -> bool

Source

pub fn has_method_call_hooks(&self) -> bool

Source

pub fn has_static_method_call_hooks(&self) -> bool

Source

pub fn has_nullsafe_method_call_hooks(&self) -> bool

Source

pub fn has_class_hooks(&self) -> bool

Source

pub fn has_interface_hooks(&self) -> bool

Source

pub fn has_trait_hooks(&self) -> bool

Source

pub fn has_enum_hooks(&self) -> bool

Source

pub fn has_function_decl_hooks(&self) -> bool

Source

pub fn has_property_initialization_providers(&self) -> bool

Source

pub fn has_issue_filter_hooks(&self) -> bool

Source

pub fn has_function_assertion_providers(&self) -> bool

Source

pub fn has_method_assertion_providers(&self) -> bool

Source

pub fn has_expression_throw_providers(&self) -> bool

Source

pub fn has_function_throw_providers(&self) -> bool

Source

pub fn has_method_throw_providers(&self) -> bool

Source

pub fn before_program( &self, file: &File, program: &Program<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<HookAction>

Run all registered program hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_program( &self, file: &File, program: &Program<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered program hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn before_statement( &self, stmt: &Statement<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<HookAction>

Run all registered statement hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_statement( &self, stmt: &Statement<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered statement hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn before_expression( &self, expr: &Expression<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<ExpressionHookResult>

Run all registered expression hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_expression( &self, expr: &Expression<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered expression hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn before_function_call( &self, call: &FunctionCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<ExpressionHookResult>

Run all registered function call hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_function_call( &self, call: &FunctionCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered function call hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn before_method_call( &self, call: &MethodCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<ExpressionHookResult>

Run all registered method call hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_method_call( &self, call: &MethodCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered method call hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn before_static_method_call( &self, call: &StaticMethodCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<ExpressionHookResult>

Run all registered static method call hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_static_method_call( &self, call: &StaticMethodCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered static method call hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn before_nullsafe_method_call( &self, call: &NullSafeMethodCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<ExpressionHookResult>

Run all registered nullsafe method call hooks before analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn after_nullsafe_method_call( &self, call: &NullSafeMethodCall<'_>, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered nullsafe method call hooks after analysis.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_enter_class( &self, class: &Class<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered class declaration hooks on entry.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_leave_class( &self, class: &Class<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered class declaration hooks on exit.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_enter_interface( &self, interface: &Interface<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered interface declaration hooks on entry.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_leave_interface( &self, interface: &Interface<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered interface declaration hooks on exit.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_enter_trait( &self, trait_: &Trait<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered trait declaration hooks on entry.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_leave_trait( &self, trait_: &Trait<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered trait declaration hooks on exit.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_enter_enum( &self, enum_: &Enum<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered enum declaration hooks on entry.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_leave_enum( &self, enum_: &Enum<'_>, metadata: &ClassLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered enum declaration hooks on exit.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_enter_function( &self, function: &Function<'_>, metadata: &FunctionLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered function declaration hooks on entry.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn on_leave_function( &self, function: &Function<'_>, metadata: &FunctionLikeMetadata, context: &mut HookContext<'_, '_>, ) -> PluginResult<()>

Run all registered function declaration hooks on exit.

§Errors

Returns PluginError if any registered hook propagates one.

Source

pub fn get_function_like_callable_signature<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, artifacts: &AnalysisArtifacts, function_like: &FunctionLikeIdentifier, invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> Option<EffectiveCallableSignature>

Requests an external provider’s effective callable signature before argument analysis.

Provider failures are logged and preserve the native callable signature.

Source

pub fn get_function_like_return_type<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, function_like: &FunctionLikeIdentifier, invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> Option<ProviderResult>

Returns a provider result for a function or method invocation.

External provider failures are logged and preserve the native return type.

Source

pub fn get_function_return_type<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, function_name: &[u8], invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> ProviderResult

Returns the first applicable function return-type provider result.

External provider failures are logged and preserve the native return type.

Source

pub fn get_method_return_type<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, class_name: &[u8], method_name: &[u8], invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> ProviderResult

Returns the first applicable method return-type provider result.

External provider failures are logged and preserve the native return type.

Source

pub fn function_provider_count(&self) -> usize

Source

pub fn method_provider_count(&self) -> usize

Source

pub fn is_property_initialized( &self, codebase: &CodebaseMetadata, class_metadata: &ClassLikeMetadata, property_metadata: &PropertyMetadata, external_session: Option<&ExternalAnalysisSession>, ) -> bool

Checks whether any registered provider considers a property initialized.

External provider failures are logged and preserve native initialization analysis.

Source

pub fn get_class_initializers( &self, codebase: &CodebaseMetadata, class_metadata: &ClassLikeMetadata, external_session: Option<&ExternalAnalysisSession>, ) -> WordSet

Returns framework lifecycle methods that initialize properties on class_metadata.

External provider failures are logged and preserve native initialization analysis.

Source

pub fn get_function_like_assertions<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, function_like: &FunctionLikeIdentifier, invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> Option<InvocationAssertions>

Returns assertions for a function or method invocation.

External provider failures are logged and preserve native assertion analysis.

Source

pub fn get_function_assertions<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, function_name: &[u8], invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> Option<InvocationAssertions>

Get assertions for a function invocation from registered providers.

External provider failures are logged and preserve native assertion analysis.

Source

pub fn get_method_assertions<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, class_name: &[u8], method_name: &[u8], invocation: &Invocation<'ctx, '_, '_>, external_session: Option<&ExternalAnalysisSession>, ) -> Option<InvocationAssertions>

Get assertions for a method invocation from registered providers.

External provider failures are logged and preserve native assertion analysis.

Source

pub fn get_expression_thrown_exceptions<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, expression: &Expression<'_>, ) -> WordSet

Get thrown exception class names for an expression from registered providers.

Source

pub fn get_function_thrown_exceptions<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, function_name: &[u8], invocation: &Invocation<'ctx, '_, '_>, ) -> WordSet

Get thrown exception class names for a function invocation from registered providers.

Source

pub fn get_method_thrown_exceptions<'ctx>( &self, codebase: &'ctx CodebaseMetadata, source_file: &'ctx File, block_context: &BlockContext<'ctx>, artifacts: &AnalysisArtifacts, class_name: &[u8], method_name: &[u8], invocation: &Invocation<'ctx, '_, '_>, ) -> WordSet

Get thrown exception class names for a method invocation from registered providers.

Source

pub fn filter_issues( &self, file: &File, issues: IssueCollection, codebase: &CodebaseMetadata, session: Option<&ExternalAnalysisSession>, ) -> PluginResult<IssueCollection>

Filter issues through all registered issue filter hooks.

Returns a new IssueCollection with filtered issues.

§Errors

Returns an error when a native hook fails or an external issue batch cannot be filtered.

Trait Implementations§

Source§

impl Debug for PluginRegistry

Source§

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

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

impl Default for PluginRegistry

Source§

fn default() -> PluginRegistry

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = !

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more