Struct superfusion::index::Index

pub struct Index { /* fields omitted */ }

A relative path to the project that also carry information about where the path is from.

Implementations

impl Index

pub fn new(pid: Pid, path: impl Into<PathBuf>) -> Self

pub fn path(&self) -> &Path

pub fn pid(&self) -> &Pid

pub fn is_similar(&self, other: &Self) -> bool

Compare only the path component of this struct

let foo = Index::new(Pid::new(0), "./path/to/index");
let bar = Index::new(Pid::new(1), "./path/to/index");
assert!(foo.is_similar(&bar));

let baz = Index::new(Pid::new(1), "./not/a/path/to/index");
assert!(!foo.is_similar(&baz));

pub fn rename<F>(&self, format: F) -> Result<Self, Error> where
    F: Fn(&Pid, &str) -> String, 

This method will attempt to create a file name that is unique across the entire workspace. It's usually called when workspace found a conflicting file.

Note

1. format is a 'formatter function', this function must return a unique formatted string base on its Pid and filename.
2. Changing file extension is not permitted.

Error

This function can fail in the following errors:

• Logical parent does not exists. (Path like ./ does not have logical parent)
• Unable to get file stem of this path. (Check Path::file_stem())

pub fn prefix(&self, root: &Path) -> PathBuf

Transforming the Index into full path again by prefixing the relative path with the given root

pub fn with_pid(&self, pid: Pid) -> Self

Return the same Index with different Pid

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Display for Index

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

Formats the value using the given formatter.

impl Eq for Index

impl<'a> FromIterator<&'a Index> for IndexList<'a>

fn from_iter<T: IntoIterator<Item = &'a Index>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Index

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Index> for Index

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Index

impl StructuralPartialEq for Index