Struct xtest_data::Vcs

pub struct Vcs<'paths> { /* fields omitted */ }

A builder for test data.

On a VCS copy of the surrounding package this will simply collect and validate the information. However, when executed in an unpacked .crate then, instead, we provide a detailed report of necessary data before we abort.

Implementations

impl<'lt> Vcs<'lt>

pub fn filter(self, iter: impl IntoIterator<Item = FsItem<'lt>>) -> Self

Register some paths to rewrite to their location.

The paths will be registered internally. If the repository is local they will be rewritten to be relative to the manifest location. If the repository is a crate distribution then the paths will be sparsely checked out (meaning: only that path will be downloaded from the VCS working dir and you can’t expect any other files to be present).

Both of those actions will happen when you call [build()].

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

Register the path of a file.

The return value is a key that can later be used in FsData.

pub fn tree(&mut self, path: impl AsRef<Path>) -> Tree

pub fn build(self) -> FsData

Run the final validation and return the frozen dictionary of file data.

Panics

This will panic if:

• Any registered file or tree is not tracked in the VCS.
• You have not allowed retrieving data from the VCS.
• It was not possible to retrieve the data from the VCS.

Trait Implementations

impl<'paths> Debug for Vcs<'paths>

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

Formats the value using the given formatter.