Struct cargo::util::flock::Filesystem
source · pub struct Filesystem {
root: PathBuf,
}
Expand description
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.
Fields§
§root: PathBuf
Implementations§
source§impl Filesystem
impl Filesystem
sourcepub fn new(path: PathBuf) -> Filesystem
pub fn new(path: PathBuf) -> Filesystem
Creates a new filesystem to be rooted at the given path.
sourcepub fn join<T: AsRef<Path>>(&self, other: T) -> Filesystem
pub fn join<T: AsRef<Path>>(&self, other: T) -> Filesystem
Like Path::join
, creates a new filesystem rooted at this filesystem
joined with the given path.
sourcepub fn push<T: AsRef<Path>>(&mut self, other: T)
pub fn push<T: AsRef<Path>>(&mut self, other: T)
Like Path::push
, pushes a new path component onto this filesystem.
sourcepub fn into_path_unlocked(self) -> PathBuf
pub fn into_path_unlocked(self) -> PathBuf
Consumes this filesystem and returns the underlying PathBuf
.
Note that this is a relatively dangerous operation and should be used with great caution!.
sourcepub fn as_path_unlocked(&self) -> &Path
pub fn as_path_unlocked(&self) -> &Path
Returns the underlying Path
.
Note that this is a relatively dangerous operation and should be used with great caution!.
sourcepub fn create_dir(&self) -> CargoResult<()>
pub fn create_dir(&self) -> CargoResult<()>
Creates the directory pointed to by this filesystem.
Handles errors where other Cargo processes are also attempting to concurrently create this directory.
sourcepub fn display(&self) -> Display<'_>
pub fn display(&self) -> Display<'_>
Returns an adaptor that can be used to print the path of this filesystem.
sourcepub fn open_rw<P>(
&self,
path: P,
config: &Config,
msg: &str
) -> CargoResult<FileLock>where
P: AsRef<Path>,
pub fn open_rw<P>( &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.
sourcepub fn open_ro<P>(
&self,
path: P,
config: &Config,
msg: &str
) -> CargoResult<FileLock>where
P: AsRef<Path>,
pub fn open_ro<P>( &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.
fn open( &self, path: &Path, opts: &OpenOptions, state: State, config: &Config, msg: &str ) -> CargoResult<FileLock>
Trait Implementations§
source§impl Clone for Filesystem
impl Clone for Filesystem
source§fn clone(&self) -> Filesystem
fn clone(&self) -> Filesystem
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Filesystem
impl Debug for Filesystem
source§impl PartialEq<Filesystem> for Path
impl PartialEq<Filesystem> for Path
source§fn eq(&self, other: &Filesystem) -> bool
fn eq(&self, other: &Filesystem) -> bool
self
and other
values to be equal, and is used
by ==
.Auto Trait Implementations§
impl RefUnwindSafe for Filesystem
impl Send for Filesystem
impl Sync for Filesystem
impl Unpin for Filesystem
impl UnwindSafe for Filesystem
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 24 bytes