Struct devbox_build::Dir

pub struct Dir { /* fields omitted */ }

Resource representing file system directory

Implementations

impl Dir

pub fn new<P: AsRef<Path>>(path: P) -> Self

Create new Dir pointing to absolute file system path panicking if failed

pub fn new_safe<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn Error>>

Create new Dir pointing to absolute file system path

pub fn path(&self) -> &Path

Path reference to file system directory

pub fn created(self) -> Self

Creates the directory using create and returns itself or stops the build with informative error message.

pub fn create(&self)

Creates the directory using create_result or stops the build with informative error message.

pub fn create_result(&self) -> Result<()>

Creates the directory and any missing parent directories on it's path.

pub fn content<G: AsRef<str>>(&self, glob: G) -> DirContent<Unit>

All directory content (files, directories and links) matching given glob file name pattern

pub fn dirs<G: AsRef<str>>(&self, glob: G) -> DirContent<Dir>

All subdirectories and directory links matching given glob file name pattern

pub fn files<G: AsRef<str>>(&self, glob: G) -> DirContent<File>

All files and file links matching given glob file name pattern

pub fn dir<P: AsRef<Path>>(&self, path: P) -> Dir

Subdirectory at given relative path

Will stop the build with informative error message if path is not relative.

pub fn dir_result<P: AsRef<Path>>(
    &self,
    path: P
) -> Result<Self, Box<dyn Error>>

Subdirectory at given relative path

pub fn file<P: AsRef<Path>>(&self, path: P) -> File

A file at given relative path

Will stop the build with informative error message if path is not relative.

pub fn file_result<P: AsRef<Path>>(
    &self,
    path: P
) -> Result<File, Box<dyn Error>>

A file at given relative path

pub fn linked_from_inside(self, dir: &Dir) -> Self

Creating a link to this directory from another directory with this directory's name returning self or stopping the build with informative error message.

If the directory already contains an entry with this name, linking fails.

pub fn link_from_inside(&self, dir: &Dir)

Creating a link to this directory from another directory with this directory's name or stopping the build with informative error message.

If the directory already contains an entry with this name, linking fails.

pub fn link_from_inside_result(&self, dir: &Dir, force: bool) -> Result<()>

Creating a link to this directory from another directory with this directory's name.

If the directory already contains a file or directory by this name, linking fails. To allow overwriting existing link with different target set force to true or linking to this directory will also fail.

pub fn linked_to(self, to: &Dir) -> Self

Create a symbolic link at this directory path to given target directory to creating any needed directories in the process returning self or stopping the build with informative error message.

If a file or directory by that name already exists, linking will fail.

pub fn link_to(&self, to: &Dir)

Create a symbolic link at this directory path to given target directory to creating any needed directories in the process or stopping the build with informative error message.

If a file or directory by that name already exists, linking will fail.

pub fn link_to_result(&self, to: &Dir, force: bool) -> Result<()>

Create a symbolic link at this directory path to given target directory to creating any needed directories in the process.

If a file or directory by that name already exists, linking will fail. To allow overwriting existing link to a different directory set force to true or linking to a different directory will also fail.

pub fn touched(self) -> Self

Touches the directory using touch and returns itself or stops the build with informative error message

pub fn touch(&self)

Touches the directory using touch and returns itself or stops the build with informative error message.

pub fn touch_result(&self) -> Result<()>

Touches the directory by updating it's modification time or creating a new one if it does not exists yet including any needed directories.

Trait Implementations

impl<'_, '_> Add<&'_ Dir> for &'_ File

type Output = Set<Unit>

The resulting type after applying the + operator.

fn add(self, rhs: &Dir) -> Self::Output

Performs the + operation.

impl<'_, '_> Add<&'_ Dir> for &'_ Dir

type Output = Set<Dir>

The resulting type after applying the + operator.

fn add(self, rhs: &Dir) -> Self::Output

Performs the + operation.

impl<'_, '_> Add<&'_ File> for &'_ Dir

type Output = Set<Unit>

The resulting type after applying the + operator.

fn add(self, rhs: &File) -> Self::Output

Performs the + operation.

impl AsRef<Dir> for Dir

fn as_ref(&self) -> &Dir

Performs the conversion.

impl AsRef<OsStr> for Dir

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for Dir

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for Dir

fn clone(&self) -> Dir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir

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

Formats the value using the given formatter.

impl Display for Dir

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Dir

impl Hash for Dir

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 Ord for Dir

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Dir> for Dir

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

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

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

This method tests for !=.

impl PartialOrd<Dir> for Dir

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

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

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

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

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

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

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

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

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

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

impl Resource for Dir

fn timestamp(&self) -> Option<SystemTime>

Name of the resource used for logging and error reporting Return resource timestamp. Can be None for input resources that should be considered as changed in every build run or output resources that do not exists yet.

fn mk_from<F, R, S>(&self, description: &str, src: S, by: F) where
    R: Resource,
    S: AsResource<R>,
    F: FnOnce(), 

Build the resource form a given src resource as a side product of given function by respecting resource timestamps meaning that function by will only be ran if the output needs to be build.

fn mk_from_result<E, F, R, S>(
    &self,
    description: &str,
    src: S,
    by: F
) -> Result<(), E> where
    R: Resource,
    S: AsRef<R>,
    F: FnOnce() -> Result<(), E>, 

Same as mk_from() with error propagation

impl StructuralEq for Dir

impl StructuralPartialEq for Dir