Struct tugger_file_manifest::FileManifest

pub struct FileManifest { /* private fields */ }

Represents a collection of files.

Files are keyed by their path. The file content is abstract and can be backed by multiple sources.

Implementations

impl FileManifest

pub fn new_with_links() -> Self

Create a new instance that allows the storage of links.

pub fn is_empty(&self) -> bool

Whether the instance has any files entries.

pub fn add_path(
    &mut self,
    path: impl AsRef<Path>,
    strip_prefix: impl AsRef<Path>
) -> Result<(), FileManifestError>

Add a file on the filesystem to the manifest.

The filesystem path must have a prefix specified which will be stripped from the manifest path. This prefix must appear in the passed path.

The stored file data is a reference to the file path. So that file must outlive this manifest instance.

pub fn add_path_memory(
    &mut self,
    path: impl AsRef<Path>,
    strip_prefix: impl AsRef<Path>
) -> Result<(), FileManifestError>

Add a file on the filesystem to this manifest, reading file data into memory.

This is like add_path() except the file is read and its contents stored in memory. This ensures that the file can be materialized even if the source file is deleted.

pub fn add_file_entry(
    &mut self,
    path: impl AsRef<Path>,
    entry: impl Into<FileEntry>
) -> Result<(), FileManifestError>

Add a FileEntry to this manifest under the given path.

The path cannot contain relative paths and must not be absolute.

pub fn add_files(
    &mut self,
    files: impl Iterator<Item = File>
) -> Result<(), FileManifestError>

Add an iterable of File to this manifest.

pub fn add_symlink(
    &mut self,
    manifest_path: impl AsRef<Path>,
    link_target: impl AsRef<Path>
) -> Result<(), FileManifestError>

Add a symlink to the manifest.

pub fn add_manifest(&mut self, other: &Self) -> Result<(), FileManifestError>

Merge the content of another manifest into this one.

All entries from the other manifest are overlayed into this manifest while preserving paths exactly. If this manifest already has an entry for a given path, it will be overwritten by an entry in the other manifest.

pub fn relative_directories(&self) -> Vec<PathBuf>

Obtain all relative directories contained within files in this manifest.

The root directory is not represented in the return value.

pub fn resolve_directories(&self, relative_to: impl AsRef<Path>) -> Vec<PathBuf>

Resolve all required directories relative to another directory.

The root directory itself is included.

pub fn has_path(&self, path: impl AsRef<Path>) -> bool

Whether this manifest contains the specified file path.

pub fn get(&self, path: impl AsRef<Path>) -> Option<&FileEntry>

Obtain the entry for a given path.

pub fn iter_entries(&self) -> Iter<'_, PathBuf, FileEntry>

Obtain an iterator over paths and file entries in this manifest.

pub fn iter_files(&self) -> impl Iterator<Item = File> + '_

Obtain an iterator of entries as File instances.

pub fn remove(&mut self, path: impl AsRef<Path>) -> Option<FileEntry>

Remove an entry from this manifest.

pub fn entries_by_directory(
    &self
) -> BTreeMap<Option<&Path>, BTreeMap<&OsStr, (&Path, &FileEntry)>>

Obtain entries in this manifest grouped by directory.

The returned map has keys corresponding to the relative directory and values of files in that directory.

The root directory is modeled by the None key.

pub fn materialize_files(
    &self,
    dest: impl AsRef<Path>
) -> Result<Vec<PathBuf>, FileManifestError>

Write files in this manifest to the specified path.

Existing files will be replaced if they exist.

pub fn materialize_files_with_replace(
    &self,
    dest: impl AsRef<Path>
) -> Result<Vec<PathBuf>, FileManifestError>

Calls materialize_files() but removes the destination directory if it exists.

This ensures the content of the destination reflects exactly what’s defined in this manifest.

pub fn ensure_in_memory(&mut self) -> Result<(), Error>

Ensure the content of all entries is backed by memory.

Trait Implementations

impl Clone for FileManifest

fn clone(&self) -> FileManifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileManifest

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

Formats the value using the given formatter.

impl Default for FileManifest

fn default() -> FileManifest

Returns the “default value” for a type.

impl PartialEq<FileManifest> for FileManifest

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

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

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

This method tests for !=.

impl StructuralPartialEq for FileManifest