Struct AppendTextComment

pub struct AppendTextComment { /* private fields */ }

A rule to append a comment at the beginning or the end of each file.

Implementations

impl AppendTextComment

pub fn new(value: impl Into<String>) -> Self

pub fn from_file_content(file_path: impl Into<PathBuf>) -> Self

pub fn at_end(self) -> Self

Trait Implementations

impl Debug for AppendTextComment

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

Formats the value using the given formatter.

impl Default for AppendTextComment

fn default() -> AppendTextComment

Returns the “default value” for a type.

impl Rule for AppendTextComment

fn process( &self, block: &mut Block, context: &Context<'_, '_, '_>, ) -> RuleProcessResult

This method should mutate the given block to apply the rule

fn require_content( &self, _current_source: &Path, _current_block: &Block, ) -> Vec<PathBuf>

Return the list of paths to Lua files that is necessary to apply this rule. This will load each AST block from these files into the context object.

impl RuleConfiguration for AppendTextComment

fn configure( &mut self, properties: RuleProperties, ) -> Result<(), RuleConfigurationError>

The rule deserializer will construct the default rule and then send the properties through this method to modify the behavior of the rule.

fn get_name(&self) -> &'static str

This method should return the unique name of the rule.

fn serialize_to_properties(&self) -> RuleProperties

For implementing the serialize trait on the Rule trait, this method should return all properties that differs from their default value.

fn has_properties(&self) -> bool

Returns true if the rule has at least one property.