Enum PathTokenError 

pub enum PathTokenError {
    Empty,
    Separator,
    ParentDir,
    CurDir,
    NulByte,
    Colon,
    Unindexable,
}

Why a string is not a safe path token.

An untrusted string becomes a path component in several places: a blob’s id/namespace (interpolated into its on-disk file path and cloud object key), and a store_id/sid from an untrusted device invitation or restore code (the name of a directory under stores/). All arrive from outside — an incoming changeset authored by any write-capable member, or a pasted code anyone can craft — so an unconstrained one could climb out of the directory it is joined onto (.., a path separator, an absolute leading slash) and make a pulling or joining device read, write, or recursively delete an arbitrary location, or — too short / not aligned to a char boundary — crash a blob’s partition-prefix slice. A string that trips any of these is bad data, refused before a path is built or used.

Variants

Empty

The token is empty — no file name to write, no key to form.

Separator

The token contains a path separator (/ or \), so joining it onto a directory would descend into (or, with a leading separator, replace) the path rather than name a single child.

ParentDir

The token is exactly .., which names the parent of the directory it is joined onto rather than a child. A trailing .. component is normalized away when the path is resolved, so the join lands on the parent.

CurDir

The token is exactly ., which names the directory it is joined onto itself rather than a child. Like .., a trailing . component is normalized away, so stores/. resolves to stores’s parent (the data dir) — an escape just as .. is.

NulByte

The token contains a NUL byte, which truncates the path at the OS boundary.

Colon

The token contains a :, which on Windows names an alternate data stream (file:stream) or a drive-relative reference (c:dir) rather than a child.

Unindexable

The dash-stripped id is too short, or splits a multi-byte char, to take the two leading byte-pairs the {ab}/{cd} partition prefix needs.

Trait Implementations

impl Clone for PathTokenError

fn clone(&self) -> PathTokenError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathTokenError

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

Formats the value using the given formatter.

impl Display for PathTokenError

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

Formats the value using the given formatter.

impl Error for PathTokenError

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<PathTokenError> for CachedLocatorRemovalError

fn from(source: PathTokenError) -> Self

Converts to this type from the input type.

impl From<PathTokenError> for LocalBlobRemovalError

fn from(source: PathTokenError) -> Self

Converts to this type from the input type.

impl From<PathTokenError> for LocalBlobStoreError

fn from(source: PathTokenError) -> Self

Converts to this type from the input type.

impl From<PathTokenError> for RequiredLocalBlobPathError

fn from(source: PathTokenError) -> Self

Converts to this type from the input type.

impl From<PathTokenError> for StoreBlobFileError

fn from(source: PathTokenError) -> Self

Converts to this type from the input type.

impl PartialEq for PathTokenError

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

impl StructuralPartialEq for PathTokenError