Struct ConfigPlugin

#[non_exhaustive]
pub struct ConfigPlugin;

Plugin that enables ignoring modules not involved in the current config.

Mostly useful for marking test modules to prevent usage of their functionality out of tests, and reduce compilation time when the tests data isn’t required.

Trait Implementations

impl Debug for ConfigPlugin

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

Formats the value using the given formatter.

impl Default for ConfigPlugin

fn default() -> ConfigPlugin

Returns the “default value” for a type.

impl MacroPlugin for ConfigPlugin

fn generate_code( &self, db: &dyn SyntaxGroup, item_ast: ModuleItem, metadata: &MacroPluginMetadata<'_>, ) -> PluginResult

Generates code for an item. If no code should be generated returns None. Otherwise, returns (virtual_module_name, module_content), and a virtual submodule with that name and content should be created.

fn declared_attributes(&self) -> Vec<String>

Attributes this plugin uses. Attributes the plugin uses without declaring here are likely to cause a compilation error for unknown attribute. Note: They may not cause a diagnostic if some other plugin declares such attribute, but plugin writers should not rely on that.

fn declared_derives(&self) -> Vec<String>

Derives this plugin supplies. Any derived classes the plugin supplies without declaring here are likely to cause a compilation error for unknown derive. Note: They may not cause a diagnostic if some other plugin declares such derive, but plugin writers should not rely on that.

fn executable_attributes(&self) -> Vec<String>

Attributes that should mark the function as an executable. Functions marked with executable attributes will be listed in a dedicated field in the generated program. Must return a subset of declared_attributes. This mechanism is optional.

fn phantom_type_attributes(&self) -> Vec<String>

Attributes that mark a type as a phantom type. Must return a subset of declared_attributes. This mechanism is optional.