Struct devbox_build::File

pub struct File { /* fields omitted */ }

Resource representing file system file

Implementations

impl File

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

Create new File pointing to absolute file system path

pub fn path(&self) -> &Path

Path reference to file system file

pub fn created(self) -> Self

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

pub fn create(&self) -> File

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

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

Creates (or truncates) the file and any missing directories on it's path in write only mode.

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

Creating a link to this file from another directory with this file'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 file from another directory with this file's name or stops 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 file from another directory with this file'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 file will also fail.

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

Create a symbolic link at this file path to given target file to creating any needed directories in the process returning self or stops 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: &File)

Create a symbolic link at this file path to given target file to creating any needed directories in the process or stops 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: &File, force: bool) -> Result<()>

Create a symbolic link at this file path to given target file 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 file set force to true or linking to a different file will also fail.

pub fn metadata(&self) -> Metadata

Opens file's metadata using metadata_result or stops the build with informative error message.

pub fn metadata_result(&self) -> Result<Metadata>

Opens file metadata

pub fn open(&self) -> File

Opens the file using open_result or stops the build with informative error message

pub fn open_result(&self) -> Result<File>

Opens the file in read only mode

pub fn rewrite<P: AsRef<[u8]>>(&self, bytes: P)

Writes the entire content to the file using rewrite_result or stops the build with informative error message

pub fn rewrite_result<P: AsRef<[u8]>>(&self, bytes: P) -> Result<()>

Writes the entire content to the file creating it if needed. This is as shorthand for create().write_all()

pub fn touched(self) -> Self

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

pub fn touch(&self)

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

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

Touches the file by updating it's modification time or creating an empty 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<&'_ File> for &'_ File

type Output = Set<File>

The resulting type after applying the + operator.

fn add(self, rhs: &File) -> 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<File> for File

fn as_ref(&self) -> &File

Performs the conversion.

impl AsRef<OsStr> for File

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for File

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Display for File

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

Formats the value using the given formatter.

impl Eq for File

impl Hash for File

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 File

fn cmp(&self, other: &File) -> 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<File> for File

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

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

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

This method tests for !=.

impl PartialOrd<File> for File

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

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

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

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

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

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

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

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

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

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

impl Resource for File

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 File

impl StructuralPartialEq for File