Enum SafeMode 

pub enum SafeMode {
    Unsafe = 0,
    Safe = 1,
    Server = 2,
    Secure = 3,
}

Controls include access and exposure of local paths during parsing.

Defaults to Self::Secure. Applications must select a lower mode to load include targets. The CLI selects its own defaults for each command.

Fixed resource limits apply in every mode. Output converters are responsible for restrictions on stylesheets, scripts, and other rendered resources.

Variants

Unsafe = 0

Allows local includes without a base-directory boundary.

HTTP(S) includes require caller-supplied allow-uri-read. The built-in transport also requires the network feature; custom providers supply their own transport. Include depth and selected text size limits still apply.

Safe = 1

Keeps local include paths beneath the effective include base directory.

The base defaults to the entry file’s parent, or the current directory for string and reader input. crate::OptionsBuilder::with_base_dir overrides it. For /workspace/docs/main.adoc, ../shared.adoc becomes /workspace/docs/shared.adoc, while /tmp/shared.adoc becomes /workspace/docs/tmp/shared.adoc; both transformations emit a warning. This check does not resolve symlinks, so /workspace/docs/linked.adoc may point outside the directory. HTTP(S) includes require caller permission as in Unsafe mode.

Server = 2

Applies Safe mode’s include boundary and hides local directory and home paths.

docfile exposes the entry filename instead of its full path. HTTP(S) includes require caller permission as in Unsafe mode.

Secure = 3

Disables local and remote include reads, and hides paths as in Server mode.

Include directives become link fallbacks with source-recovery warnings. crate::parse_file can still read the entry file selected by the caller.

Implementations

impl SafeMode

pub const fn level(self) -> u8

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

Trait Implementations

impl Clone for SafeMode

fn clone(&self) -> Self

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() -> Self

Returns the “default value” for a type.

impl Eq for SafeMode

impl FromStr for SafeMode

type Err = String

The associated error which can be returned from parsing.

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

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

impl PartialEq for SafeMode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SafeMode

fn partial_cmp(&self, other: &Self) -> 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