Enum Policy 

pub enum Policy {
    Safe,
    Legal,
    All,
}

Which comments survive by default.

A policy is the last word, not the first: ScanOptions::keep_kinds, ScanOptions::keep_regex, ScanOptions::remove_kinds and ScanOptions::remove_regex are all tested before it. The full table of policy against CommentKind is in the crate documentation.

Variants

Safe

The default. Removes ordinary, documentation, and license comments; keeps directives, HTML comments, SQL hints and version comments, and the shebang or encoding preamble.

Legal

As Self::Safe, but license and copyright notices are kept too.

All

Removes every comment, directives and HTML comments included. The shebang and encoding preamble still survive unless ScanOptions::force_protected is set.

Implementations

impl Policy

pub const ALL: [Self; 3]

Every CLI-visible policy.

pub const fn as_str(self) -> &'static str

The canonical name, identical to the serde representation.

pub const fn aliases(self) -> &'static [&'static str]

Accepted spellings besides Self::as_str, already case-folded.

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Policy

impl Debug for Policy

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

Formats the value using the given formatter.

impl Default for Policy

fn default() -> Policy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Policy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Policy

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

Formats the value using the given formatter.

impl Eq for Policy

impl FromStr for Policy

type Err = String

The associated error which can be returned from parsing.

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

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

impl Hash for Policy

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 Policy

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Policy

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 Policy