Skip to main content

CacheTarget

Struct CacheTarget 

Source
pub struct CacheTarget<'a> { /* private fields */ }
Expand description

A cache directory and the directory that its writes must stay in.

Every cache writer takes this type instead of a bare directory, so a writer cannot skip the symlink check.

Implementations§

Source§

impl<'a> CacheTarget<'a>

Source

pub fn new(root: &'a Path, dir: &'a Path) -> Self

The cache directory dir of the project at root.

Source

pub const fn inside(dir: &'a Path) -> Self

A cache directory that is its own base, such as a directory that the user chose.

Source

pub const fn dir(&self) -> &'a Path

The cache directory.

Source

pub const fn with_dir(&self, dir: &'a Path) -> Self

The same base with dir as the cache directory, for a subdirectory.

Source

pub fn check(&self, path: &Path) -> Result<()>

Fail when a write to path would follow a symlink that leaves the base.

§Errors

Returns the error of ensure_no_outside_link.

Source

pub fn write_file(&self, name: &str, data: &[u8]) -> Result<()>

Create the cache directory and replace the file name in it with data through crate::atomic_file::write_atomic, after the symlink check.

§Errors

Returns the error of the check, of the directory creation, or of the write.

Source

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

Write .gitignore with *, so the cache directory is never committed. An equal file stays as it is.

§Errors

Returns the error of Self::write_file.

Trait Implementations§

Source§

impl<'a> Clone for CacheTarget<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for CacheTarget<'a>

Source§

impl<'a> Debug for CacheTarget<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Forget for CacheTarget<'a>

§

impl<'a> Freeze for CacheTarget<'a>

§

impl<'a> Move for CacheTarget<'a>

§

impl<'a> RefUnwindSafe for CacheTarget<'a>

§

impl<'a> Send for CacheTarget<'a>

§

impl<'a> Sync for CacheTarget<'a>

§

impl<'a> Unpin for CacheTarget<'a>

§

impl<'a> UnsafeUnpin for CacheTarget<'a>

§

impl<'a> UnwindSafe for CacheTarget<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
Source§

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

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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.