Struct ScanOptions 

pub struct ScanOptions {
    pub policy: Policy,
    pub dialect: Dialect,
    pub force_invalid: bool,
    pub force_protected: bool,
    pub keep_kinds: Vec<CommentKind>,
    pub remove_kinds: Vec<CommentKind>,
    pub keep_regex: Vec<String>,
    pub remove_regex: Vec<String>,
}

Everything that decides what a scan finds and what it does with it.

Self::default is the Policy::Safe policy with no overrides.

Fields

policy: Policy

Which kinds survive by default.

dialect: Dialect

The vendor rules to lex with. It must be one the language supports.

force_invalid: bool

Edit even a source the scanner reported invalid. Without it a file with an unterminated comment or string comes back byte for byte.

force_protected: bool

Remove the shebang and encoding preamble as well. Nothing else protects them.

keep_kinds: Vec<CommentKind>

Kinds kept whatever the policy says. Tested before everything else.

remove_kinds: Vec<CommentKind>

Kinds removed unless a keep rule claimed them first.

keep_regex: Vec<String>

Byte-regexes that protect matching complete comment tokens.

remove_regex: Vec<String>

Byte-regexes that remove matching complete comment tokens.

Trait Implementations

impl Clone for ScanOptions

fn clone(&self) -> ScanOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanOptions

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

Formats the value using the given formatter.

impl Default for ScanOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScanOptions

where ScanOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScanOptions

impl Hash for ScanOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScanOptions

fn eq(&self, other: &ScanOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ScanOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScanOptions