Struct mutiny::components::SourcePath

pub struct SourcePath(pub PathBuf);

Methods from Deref<Target = PathBuf>

pub fn as_path(&self) -> &Path

Coerces to a Path slice.

Examples

use std::path::{Path, PathBuf};

let p = PathBuf::from("/test");
assert_eq!(Path::new("/test"), p.as_path());

pub fn push<P>(&mut self, path: P) where     P: AsRef<Path>,

Extends self with path.

If path is absolute, it replaces the current path.

On Windows:

• if path has a root but no prefix (e.g. \windows), it replaces everything except for the prefix (if any) of self.
• if path has a prefix but no root, it replaces self.

Examples

Pushing a relative path extends the existing path:

use std::path::PathBuf;

let mut path = PathBuf::from("/tmp");
path.push("file.bk");
assert_eq!(path, PathBuf::from("/tmp/file.bk"));

Pushing an absolute path replaces the existing path:

use std::path::PathBuf;

let mut path = PathBuf::from("/tmp");
path.push("/etc");
assert_eq!(path, PathBuf::from("/etc"));

pub fn pop(&mut self) -> bool

Truncates self to self.parent.

Returns false and does nothing if self.file_name is None. Otherwise, returns true.

Examples

use std::path::{Path, PathBuf};

let mut p = PathBuf::from("/test/test.rs");

p.pop();
assert_eq!(Path::new("/test"), p);
p.pop();
assert_eq!(Path::new("/"), p);

pub fn set_file_name<S>(&mut self, file_name: S) where     S: AsRef<OsStr>,

Updates self.file_name to file_name.

If self.file_name was None, this is equivalent to pushing file_name.

Otherwise it is equivalent to calling pop and then pushing file_name. The new path will be a sibling of the original path. (That is, it will have the same parent.)

Examples

use std::path::PathBuf;

let mut buf = PathBuf::from("/");
assert!(buf.file_name() == None);
buf.set_file_name("bar");
assert!(buf == PathBuf::from("/bar"));
assert!(buf.file_name().is_some());
buf.set_file_name("baz.txt");
assert!(buf == PathBuf::from("/baz.txt"));

pub fn set_extension<S>(&mut self, extension: S) -> bool where     S: AsRef<OsStr>,

Updates self.extension to extension.

Returns false and does nothing if self.file_name is None, returns true and updates the extension otherwise.

If self.extension is None, the extension is added; otherwise it is replaced.

Examples

use std::path::{Path, PathBuf};

let mut p = PathBuf::from("/feel/the");

p.set_extension("force");
assert_eq!(Path::new("/feel/the.force"), p.as_path());

p.set_extension("dark_side");
assert_eq!(Path::new("/feel/the.dark_side"), p.as_path());

Trait Implementations

impl PartialOrd<SourcePath> for SourcePath

fn partial_cmp(&self, other: &SourcePath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SourcePath) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SourcePath) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SourcePath) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SourcePath) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for SourcePath

fn cmp(&self, other: &SourcePath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialEq<SourcePath> for SourcePath

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

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

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

This method tests for !=.

impl Clone for SourcePath

fn clone(&self) -> SourcePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for SourcePath

impl Debug for SourcePath

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

Formats the value using the given formatter.

impl Hash for SourcePath

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 Deref for SourcePath

type Target = PathBuf

The resulting type after dereferencing.

fn deref(&self) -> &PathBuf

Dereferences the value.

impl DerefMut for SourcePath

fn deref_mut(&mut self) -> &mut PathBuf

Mutably dereferences the value.

impl Component for SourcePath

type Storage = DenseVec<SourcePath>

fn type_name() -> &'static str

fn id() -> TypeId

impl<'a> DebugParameter for SourcePath

fn debug<S: Serializer>(     &self,     serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

impl Serialize for SourcePath

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SourcePath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.