Struct DefaultPathResolver 

pub struct DefaultPathResolver {
    pub file_separator: char,
}

The default PathResolver implementation, mirroring the Ruby Asciidoctor PathResolver class.

The main emphasis of the struct is on creating clean and secure paths. Clean paths are void of duplicate parent and current directory references in the path name. Secure paths are paths which are restricted from accessing directories outside of a jail path, if specified.

Since joining two paths can result in an insecure path, this struct also handles the task of joining a parent (start) and child (target) path.

Like its counterpart in the Ruby Asciidoctor implementation, this struct makes no use of path utilities from the underlying Rust libraries. Instead, it handles all aspects of path manipulation. The main benefit of internalizing these operations is that the struct is able to handle both Posix and Windows paths independent of the operating system on which it runs. This makes the class both deterministic and easier to test.

Fields

file_separator: char

File separator to use for path operations. (Defaults to platform-appropriate separator.)

Implementations

impl DefaultPathResolver

pub fn posixify(&self, path: &str) -> String

Normalize path by converting any backslashes to forward slashes.

pub fn is_web_root(&self, path: &str) -> bool

Return true if the path is an absolute (root) web path (i.e. starts with a '/'.

Trait Implementations

impl Clone for DefaultPathResolver

fn clone(&self) -> DefaultPathResolver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefaultPathResolver

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

Formats the value using the given formatter.

impl Default for DefaultPathResolver

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DefaultPathResolver

impl PartialEq for DefaultPathResolver

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

Equality operator ==.

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

Inequality operator !=.

impl PathResolver for DefaultPathResolver

fn web_path(&self, target: &str, start: Option<&str>) -> String

Resolve a web path from the target and start paths.

impl StructuralPartialEq for DefaultPathResolver