Enum FilePath 

pub enum FilePath {
    System(Box<SystemPath>),
    SystemVirtual(Box<SystemVirtualPath>),
    Vendored(Box<VendoredPath>),
}

Path to a file.

The path abstracts that files in Ruff can come from different sources:

• a file stored on the host system.
• a virtual file stored on the host system.
• a vendored file stored in the vendored file system.

Variants

System(Box<SystemPath>)

Path to a file on the host system.

SystemVirtual(Box<SystemVirtualPath>)

Path to a virtual file on the host system.

Vendored(Box<VendoredPath>)

Path to a file vendored as part of Ruff. Stored in the vendored file system.

Implementations

impl FilePath

pub fn system(path: impl AsRef<SystemPath>) -> Self

Create a new path to a file on the file system.

pub fn as_system_path(&self) -> Option<&SystemPath>

pub const fn is_system_path(&self) -> bool

Returns true if the path is a file system path that points to a path on disk.

pub const fn is_system_virtual_path(&self) -> bool

Returns true if the path is a file system path that is virtual i.e., it doesn’t exists on disk.

pub const fn is_vendored_path(&self) -> bool

Returns true if the path is a vendored path.

pub fn as_vendored_path(&self) -> Option<&VendoredPath>

pub fn as_str(&self) -> &str

Yields the underlying str slice.

pub fn to_file(&self, db: &dyn Db) -> Option<File>

Interns a virtual file system path and returns a salsa File ingredient.

Returns Some if a file for path exists and is accessible by the user. Returns None otherwise.

See system_path_to_file or vendored_path_to_file if you always have either a file system or vendored path.

pub fn extension(&self) -> Option<&str>

Trait Implementations

impl AsRef<str> for FilePath

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FilePath

fn clone(&self) -> FilePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilePath

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

Formats the value using the given formatter.

impl Display for FilePath

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

Formats the value using the given formatter.

impl Eq for FilePath

impl From<&SystemPath> for FilePath

fn from(value: &SystemPath) -> Self

Converts to this type from the input type.

impl From<&SystemVirtualPath> for FilePath

fn from(value: &SystemVirtualPath) -> Self

Converts to this type from the input type.

impl From<&VendoredPath> for FilePath

fn from(value: &VendoredPath) -> Self

Converts to this type from the input type.

impl From<SystemPathBuf> for FilePath

fn from(value: SystemPathBuf) -> Self

Converts to this type from the input type.

impl From<SystemVirtualPathBuf> for FilePath

fn from(value: SystemVirtualPathBuf) -> Self

Converts to this type from the input type.

impl From<VendoredPathBuf> for FilePath

fn from(value: VendoredPathBuf) -> Self

Converts to this type from the input type.

impl GetSize for FilePath

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl Hash for FilePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FilePath

fn eq(&self, other: &FilePath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<FilePath> for SystemPath

fn eq(&self, other: &FilePath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<FilePath> for SystemPathBuf

fn eq(&self, other: &FilePath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<FilePath> for VendoredPath

fn eq(&self, other: &FilePath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<FilePath> for VendoredPathBuf

fn eq(&self, other: &FilePath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SystemPath> for FilePath

fn eq(&self, other: &SystemPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<SystemPathBuf> for FilePath

fn eq(&self, other: &SystemPathBuf) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<VendoredPath> for FilePath

fn eq(&self, other: &VendoredPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<VendoredPathBuf> for FilePath

fn eq(&self, other: &VendoredPathBuf) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FilePath