Enum SafeFilePath

pub enum SafeFilePath {
    Url(Url),
    Path(SafePathBuf),
}

Represents either a safe filesystem path or a URI pointing to a file such as file:// URIs or Android content:// URIs.

Variants

Url(Url)

file:// URIs or Android content:// URIs.

Path(SafePathBuf)

Safe PathBuf, see `SafePathBuf``.

Implementations

impl SafeFilePath

pub fn as_path(&self) -> Option<&Path>

Get a reference to the contained Path if the variant is SafeFilePath::Path.

Use SafeFilePath::into_path to try to convert the SafeFilePath::Url variant as well.

pub fn into_path(self) -> Result<PathBuf, Error>

Try to convert into PathBuf if possible.

This calls Url::to_file_path if the variant is SafeFilePath::Url, otherwise returns the contained PathBuf as is.

pub fn simplified(self) -> Self

Takes the contained PathBuf if the variant is SafeFilePath::Path, and when possible, converts Windows UNC paths to regular paths.

Trait Implementations

impl Clone for SafeFilePath

fn clone(&self) -> SafeFilePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SafeFilePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SafeFilePath

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SafeFilePath

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

Formats the value using the given formatter.

impl From<SafeFilePath> for FilePath

fn from(value: SafeFilePath) -> Self

Converts to this type from the input type.

impl From<Url> for SafeFilePath

fn from(value: Url) -> Self

Converts to this type from the input type.

impl FromStr for SafeFilePath

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Serialize for SafeFilePath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Path> for SafeFilePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Path) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<&PathBuf> for SafeFilePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &PathBuf) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<FilePath> for SafeFilePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: FilePath) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<PathBuf> for SafeFilePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<SafeFilePath> for PathBuf

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SafeFilePath) -> Result<Self, Error>

Performs the conversion.