Enum SafeMode 

pub enum SafeMode {
    Unsafe = 0,
    Safe = 1,
    Server = 10,
    Secure = 20,
}

Describes the safe mode under which a document is parsed and rendered.

Safe modes provide a security model that controls how much a document is allowed to reach outside of itself. They mirror the safe modes defined by Ruby Asciidoctor, and the discriminant values are chosen so that the modes compare in order of increasing safety (Unsafe < Safe < Server < Secure). Features that could expose the host environment (for example, embedding the contents of a file directly in the output) are only enabled when the safe mode is below a threshold.

The default safe mode is SafeMode::Secure, matching the most conservative setting. A client may relax it via Parser::with_safe_mode.

Variants

Unsafe = 0

A safe mode level that disables any of the security features enforced by Asciidoctor (Ruby or otherwise). This mode is intended for use when the document is entirely trusted.

Safe = 1

A safe mode level that closely parallels Unsafe, except it prevents access to files which reside outside of the parent directory of the source file.

Server = 10

A safe mode level that disallows the document from attempting to read files from the file system and including their contents into the document. It also disables certain macros that pose a security risk.

This is the most fitting safe mode for server deployments (hence the name).

Secure = 20

A safe mode level that disallows the document from attempting to read files from the file system and including their contents into the document, and it prevents access to file system paths.

This mode allows the AsciiDoc document to be processed in a shared, server-side environment, such as a wiki, where the document should not be able to embed the contents of arbitrary files.

This is the default safe mode.

Trait Implementations

impl Clone for SafeMode

fn clone(&self) -> SafeMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SafeMode

impl Debug for SafeMode

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

Formats the value using the given formatter.

impl Default for SafeMode

fn default() -> SafeMode

Returns the “default value” for a type.

impl Eq for SafeMode

impl Hash for SafeMode

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 Ord for SafeMode

fn cmp(&self, other: &SafeMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SafeMode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for SafeMode

fn partial_cmp(&self, other: &SafeMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SafeMode