Enum PathSafetyError 

pub enum PathSafetyError {
    OutsideWorkspace {
        path: PathBuf,
        workspace_root: PathBuf,
    },
    SymlinkTarget {
        path: PathBuf,
    },
    SymlinkInAncestor {
        ancestor: PathBuf,
    },
    Io(Error),
}

Error variants returned by validate_path_in_workspace.

Variants

OutsideWorkspace

The canonicalized path is not a descendant of the workspace root.

This is triggered by absolute paths that escape the workspace, or by relative paths containing enough .. components to escape after joining.

Fields

path: PathBuf

The resolved path that was found to be outside the workspace.

workspace_root: PathBuf

The canonical workspace root used for the comparison.

SymlinkTarget

The final path component is a symlink (detected via symlink_metadata; the symlink is NOT followed).

sqry refuses to write to or read from symlink targets to prevent TOCTOU races and silent redirection of persistence data.

Fields

path: PathBuf

The path whose final component is a symlink.

SymlinkInAncestor

A directory ancestor of the path — between the path and the workspace root — is a symlink.

An attacker controlling a symlinked ancestor directory could redirect all writes inside that subtree to an arbitrary location.

Fields

ancestor: PathBuf

The ancestor directory path that was found to be a symlink.

Io(Error)

A transparent wrapper around a std::io::Error.

Trait Implementations

impl Debug for PathSafetyError

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

Formats the value using the given formatter.

impl Display for PathSafetyError

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

Formats the value using the given formatter.

impl Error for PathSafetyError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for PathSafetyError

fn from(e: Error) -> Self

Converts to this type from the input type.