Struct PathResolver 

pub struct PathResolver {
    pub file_separator: char,
}

A PathResolver handles all operations for resolving, cleaning, and joining paths. This struct includes operations for handling both web paths (request URIs) and system paths.

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 PathResolver

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

Normalize path by converting any backslashes to forward slashes.

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

Resolve a web path from the target and start paths.

The main function of this operation is to resolve any parent references and remove any self references.

The target is assumed to be a path, not a qualified URI. That check should happen before this method is invoked.

Returns a path that joins the target path with the start path with any parent references resolved and self references removed.

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 PathResolver

fn clone(&self) -> PathResolver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathResolver

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

Formats the value using the given formatter.

impl Default for PathResolver

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PathResolver

fn eq(&self, other: &PathResolver) -> 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 Eq for PathResolver

impl StructuralPartialEq for PathResolver