brane_cli::data

Function build

Source 
pub async fn build(
    file: impl AsRef<Path>,
    workdir: impl AsRef<Path>,
    _keep_files: bool,
    no_links: bool,
) -> Result<(), DataError>
Expand description

Builds the given data.yml file to a locally usable package.

§Arguments

  • file: The data.yml file to use as the definition.
  • workdir: The directory to resolve all relative paths to.
  • keep_files: Keep any intermediate build files.
  • no_links: Always copy files to the Brane data folder to prevent links going all over the system.

§Returns

Nothing, but does build a new dataset in the ~/.local/share/brane/data folder.

§Errors

This function may error if the build failed for any reason. Typically, this may be filesystem/IO errors or malformed data.yml / paths.