Struct quickcfg::FileSystem

source ·
pub struct FileSystem<'a> { /* private fields */ }
Expand description

Helper and tracker of any filesystem modifications.

Implementations§

source§

impl<'a> FileSystem<'a>

source

pub fn new( opts: &'a Opts, state_dir: &Path, allocator: &'a UnitAllocator, data: &'a Data ) -> FileSystem<'a>

Create new, thread-safe file utilities.

source

pub fn validate(self) -> Result<(), Error>

Validate that we haven’t created any conflicting files. Logs details and errors in case duplicates are registered.

source

pub fn file_dependency(&self, path: &Path) -> Result<Dependency, Error>

Access or allocate a file dependency of the given path.

source

pub fn dir_dependency(&self, path: &Path) -> Result<Dependency, Error>

Access or allocate a directory dependency of the given path.

Try to create a symlink.

source

pub fn copy_file( &self, from: &Path, from_meta: Metadata, to: &Path, to_meta: Option<&Metadata>, template: bool ) -> Result<Option<SystemUnit>, Error>

Optionally set up if we should copy a file.

This is true if:

  • The destination file does not exist.
  • The destination file has a modified timestamp less than the source file.
source

pub fn create_dir_all(&self, dir: &Path) -> Result<Vec<SystemUnit>, Error>

Recursively set up units with dependencies to create the given directories.

source

pub fn state_path(&self, id: &str) -> PathBuf

Get the state path for the given ID.

source

pub fn try_open_meta(p: &Path) -> Result<Option<Metadata>, Error>

Try to open metadata, unless the file does not exist.

If the file does not exist, returns None.

source

pub fn should_create_dir( path: &Path, meta: Option<&Metadata> ) -> Result<bool, Error>

Test if we should create the destination directory.

source

pub fn path_relative_from(path: &Path, base: &Path) -> Option<PathBuf>

Construct a relative path from a provided base directory path to the provided path

use quickcfg::FileSystem;
use std::path::PathBuf;

let baz: PathBuf = "/foo/bar/baz".into();
let bar: PathBuf = "/foo/bar".into();
let quux: PathBuf = "/foo/bar/quux".into();
assert_eq!(FileSystem::path_relative_from(&bar, &baz), Some("../".into()));
assert_eq!(FileSystem::path_relative_from(&baz, &bar), Some("baz".into()));
assert_eq!(FileSystem::path_relative_from(&quux, &baz), Some("../quux".into()));
assert_eq!(FileSystem::path_relative_from(&baz, &quux), Some("../baz".into()));
assert_eq!(FileSystem::path_relative_from(&bar, &quux), Some("../".into()));
source

pub fn touch(path: &Path, timestamp: &SystemTime) -> Result<(), Error>

Update timestamps for the given path.

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for FileSystem<'a>

§

impl<'a> Send for FileSystem<'a>

§

impl<'a> Sync for FileSystem<'a>

§

impl<'a> Unpin for FileSystem<'a>

§

impl<'a> UnwindSafe for FileSystem<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more