[−][src]Struct cargo::util::Filesystem
A "filesystem" is intended to be a globally shared, hence locked, resource in Cargo.
The Path
of a filesystem cannot be learned unless it's done in a locked
fashion, and otherwise functions on this structure are prepared to handle
concurrent invocations across multiple instances of Cargo.
Methods
impl Filesystem
[src]
pub fn new(path: PathBuf) -> Filesystem
[src]
Creates a new filesystem to be rooted at the given path.
pub fn join<T: AsRef<Path>>(&self, other: T) -> Filesystem
[src]
Like Path::join
, creates a new filesystem rooted at this filesystem
joined with the given path.
pub fn push<T: AsRef<Path>>(&mut self, other: T)
[src]
Like Path::push
, pushes a new path component onto this filesystem.
pub fn into_path_unlocked(self) -> PathBuf
[src]
Consumes this filesystem and returns the underlying PathBuf
.
Note that this is a relatively dangerous operation and should be used with great caution!.
pub fn create_dir(&self) -> Result<()>
[src]
Creates the directory pointed to by this filesystem.
Handles errors where other Cargo processes are also attempting to concurrently create this directory.
pub fn display(&self) -> Display
[src]
Returns an adaptor that can be used to print the path of this filesystem.
pub fn open_rw<P>(
&self,
path: P,
config: &Config,
msg: &str
) -> CargoResult<FileLock> where
P: AsRef<Path>,
[src]
&self,
path: P,
config: &Config,
msg: &str
) -> CargoResult<FileLock> where
P: AsRef<Path>,
Opens exclusive access to a file, returning the locked version of a file.
This function will create a file at path
if it doesn't already exist
(including intermediate directories), and then it will acquire an
exclusive lock on path
. If the process must block waiting for the
lock, the msg
is printed to config
.
The returned file can be accessed to look at the path and also has read/write access to the underlying file.
pub fn open_ro<P>(
&self,
path: P,
config: &Config,
msg: &str
) -> CargoResult<FileLock> where
P: AsRef<Path>,
[src]
&self,
path: P,
config: &Config,
msg: &str
) -> CargoResult<FileLock> where
P: AsRef<Path>,
Opens shared access to a file, returning the locked version of a file.
This function will fail if path
doesn't already exist, but if it does
then it will acquire a shared lock on path
. If the process must block
waiting for the lock, the msg
is printed to config
.
The returned file can be accessed to look at the path and also has read access to the underlying file. Any writes to the file will return an error.
Trait Implementations
impl PartialEq<Path> for Filesystem
[src]
fn eq(&self, other: &Path) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialEq<Filesystem> for Path
[src]
fn eq(&self, other: &Filesystem) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl Clone for Filesystem
[src]
fn clone(&self) -> Filesystem
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for Filesystem
[src]
Auto Trait Implementations
impl Send for Filesystem
impl Sync for Filesystem
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same for T
type Output = T
Should always be Self