Trait Rule 

pub trait Rule: RuleConfiguration + Debug {
    // Required method
    fn process(
        &self,
        block: &mut Block,
        context: &Context<'_, '_, '_>,
    ) -> RuleProcessResult;

    // Provided method
    fn require_content(
        &self,
        _current_source: &Path,
        _current_block: &Block,
    ) -> Vec<PathBuf> { ... }
}

Defines an interface for rules that can transform Lua blocks.

Rules implement this trait to define how they process blocks and how their configuration can be serialized and deserialized.

Required Methods

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

Processes the given block to apply the rule’s transformation.

Returns Ok(()) if the transformation was successful, or an error message if it failed.

Provided Methods

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

Returns a list of paths to Lua files that are required to apply this rule.

These files will be loaded into the context for use during processing.

Trait Implementations

impl<'de> Deserialize<'de> for Box<dyn Rule>

fn deserialize<D: Deserializer<'de>>( deserializer: D, ) -> Result<Box<dyn Rule>, D::Error>

Deserialize this value from the given Serde deserializer.

impl FromStr for Box<dyn Rule>

type Err = String

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for dyn Rule

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

Implementors

impl Rule for AppendTextComment

impl Rule for ConvertRequire

impl<T: FlawlessRule + RuleConfiguration + Debug> Rule for T