Enum ini::EscapePolicy

pub enum EscapePolicy {
    Nothing,
    Basics,
    BasicsUnicode,
    BasicsUnicodeExtended,
    Reserved,
    ReservedUnicode,
    ReservedUnicodeExtended,
    Everything,
}

Policies for escaping logic

Variants

Nothing

Escape absolutely nothing (dangerous)

Basics

Only escape the most necessary things. This means backslashes, control characters (codepoints U+0000 to U+001F), and delete (U+007F). Quotes (single or double) are not escaped.

BasicsUnicode

Escape basics and non-ASCII characters in the Basic Multilingual Plane (i.e. between U+007F - U+FFFF) Codepoints above U+FFFF, e.g. ‘🐱’ U+1F431 “CAT FACE” will not be escaped!

BasicsUnicodeExtended

Escape basics and all non-ASCII characters, including codepoints above U+FFFF. This will escape emoji - if you want them to remain raw, use BasicsUnicode instead.

Reserved

Escape reserved symbols. This includes everything in EscapePolicy::Basics, plus the comment characters ‘;’ and ‘#’ and the key/value-separating characters ‘=’ and ‘:’.

ReservedUnicode

Escape reserved symbols and non-ASCII characters in the BMP. Codepoints above U+FFFF, e.g. ‘🐱’ U+1F431 “CAT FACE” will not be escaped!

ReservedUnicodeExtended

Escape reserved symbols and all non-ASCII characters, including codepoints above U+FFFF.

Everything

Escape everything that some INI implementations assume

Implementations

impl EscapePolicy

pub fn should_escape(self, c: char) -> bool

Given a character this returns true if it should be escaped as per this policy or false if not.

Trait Implementations

impl Clone for EscapePolicy

fn clone(&self) -> EscapePolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EscapePolicy

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

Formats the value using the given formatter.

impl PartialEq for EscapePolicy

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EscapePolicy

impl StructuralPartialEq for EscapePolicy