Enum PreservationRule

pub enum PreservationRule {
    Pattern(String),
    Documentation,
    FileHeader,
}

Variants

Pattern(String)

Preserve comments containing a specific pattern

Documentation

Preserve documentation comments

FileHeader

Preserve comments at the beginning of files (headers)

Implementations

impl PreservationRule

pub fn matches(&self, comment: &CommentInfo) -> bool

pub fn pattern_matches(&self, pattern: &str) -> bool

Check if this rule is a pattern rule that matches the given pattern

pub fn pattern(pattern: &str) -> Self

Create a pattern-based preservation rule

pub fn documentation() -> Self

Create a documentation preservation rule

pub fn file_header() -> Self

Create a file header preservation rule

impl PreservationRule

pub fn default_rules() -> Vec<Self>

Get default preservation rules for most projects

pub fn comprehensive_rules() -> Vec<Self>

Get comprehensive preservation rules

Trait Implementations

impl Clone for PreservationRule

fn clone(&self) -> PreservationRule

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreservationRule

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

Formats the value using the given formatter.