Struct Path 

pub struct Path { /* private fields */ }

Concrete path - includes filesystem operations

Implementations

impl Path

pub fn new<P: AsRef<StdPath>>(path: P) -> Self

Create new Path

pub fn cwd() -> Result<Path, PyException>

Current working directory

pub fn home() -> Result<Path, PyException>

Home directory

pub fn absolute(&self) -> Result<Path, PyException>

Get absolute path

pub fn resolve(&self) -> Result<Path, PyException>

Resolve path (follow symlinks)

pub fn exists(&self) -> bool

Check if path exists

pub fn is_file(&self) -> bool

Check if path is file

pub fn is_dir(&self) -> bool

Check if path is directory

pub fn is_symlink(&self) -> bool

Check if path is symlink

pub fn stat(&self) -> Result<FileStats, PyException>

Get file statistics

pub fn mkdir(&self, parents: bool, exist_ok: bool) -> Result<(), PyException>

Create directory

pub fn rmdir(&self) -> Result<(), PyException>

Remove directory

pub fn unlink(&self, missing_ok: bool) -> Result<(), PyException>

Remove file

pub fn iterdir(&self) -> Result<Vec<Path>, PyException>

List directory contents

pub fn glob(&self, pattern: &str) -> Result<Vec<Path>, PyException>

Glob pattern matching

pub fn rglob(&self, pattern: &str) -> Result<Vec<Path>, PyException>

Recursive glob

pub fn read_text(&self, _encoding: Option<&str>) -> Result<String, PyException>

Read text file

pub fn write_text<S: AsRef<str>>(&self, data: S) -> Result<(), PyException>

Write text file

pub fn read_bytes(&self) -> Result<Vec<u8>, PyException>

Read bytes

pub fn write_bytes(&self, data: &[u8]) -> Result<(), PyException>

Write bytes

Methods from Deref<Target = PurePath>

pub fn parts(&self) -> Vec<String>

Get path parts

pub fn drive(&self) -> String

Get drive (Windows only)

pub fn root(&self) -> String

Get root

pub fn anchor(&self) -> String

Get anchor (drive + root)

pub fn parent(&self) -> PurePath

Get parent directory

pub fn parents(&self) -> Vec<PurePath>

Get all parents

pub fn name(&self) -> String

Get file name

pub fn suffix(&self) -> String

Get file suffix

pub fn suffixes(&self) -> Vec<String>

Get all suffixes

pub fn stem(&self) -> String

Get stem (filename without final suffix)

pub fn joinpath<P: AsRef<StdPath>>(&self, other: P) -> PurePath

Join with other path

pub fn match_pattern(&self, pattern: &str) -> bool

Check if path matches pattern

pub fn relative_to(&self, other: &PurePath) -> Result<PurePath, PyException>

Get relative path to other

pub fn is_absolute(&self) -> bool

Check if path is absolute

pub fn is_relative(&self) -> bool

Check if path is relative

pub fn as_posix(&self) -> String

Convert to string

pub fn with_name<S: AsRef<str>>(&self, name: S) -> PurePath

Replace path components

pub fn with_suffix<S: AsRef<str>>(&self, suffix: S) -> PurePath

Replace suffix

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Deref for Path

type Target = PurePath

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Path

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

Formats the value using the given formatter.

impl From<&str> for Path

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Path

fn from(s: String) -> Self

Converts to this type from the input type.