Struct PackageBuilder

pub struct PackageBuilder {
    pub abi_revision: AbiRevision,
    /* private fields */
}

A builder for Fuchsia Packages

Fields

abi_revision: AbiRevision

The abi_revision to embed in the package.

Implementations

impl PackageBuilder

pub fn new(name: impl AsRef<str>, abi_revision: AbiRevision) -> Self

Create a new PackageBuilder.

The ABI revision is included in the package exactly as given - we don’t validate it here.

pub fn new_platform_internal_package(name: impl AsRef<str>) -> Self

Create a new PackageBuilder with the platform-internal ABI revision.

The platform-internal ABI revision is only appropriate for packages that are only ever read by binaries from the exact same release. For packages that can be built by tools from one release and then run on an OS from a different release, a different ABI revision that defines the compatibility guarantees must be selected.

pub fn from_package_build_manifest( manifest: &PackageBuildManifest, abi_revision: AbiRevision, ) -> Result<Self>

Create a PackageBuilder from a PackageBuildManifest.

The ABI revision is included in the package exactly as given - we don’t validate it here. Returns an error if the given manifest already specified an ABI revision.

pub fn from_manifest( original_manifest: PackageManifest, outdir: impl AsRef<Path>, ) -> Result<Self>

Create a PackageBuilder from an existing manifest. Requires an out directory for temporarily unpacking meta.far contents.

pub fn manifest_path(&mut self, manifest_path: impl Into<Utf8PathBuf>)

Specify a path to write out the json package manifest to.

pub fn manifest_blobs_relative_to(&mut self, relative_to: RelativeTo)

pub fn overwrite_files(&mut self, overwrite_files: bool)

Specify whether new additions of a file that have already been added should overwrite, or fail

pub fn add_file_to_far( &mut self, at_path: impl AsRef<str>, file: impl AsRef<str>, ) -> Result<()>

Add a file to the package’s far.

Errors

Will return an error if the path for the file is already being used. Will return an error if any special package metadata paths are used.

pub fn remove_file_from_far(&mut self, at_path: impl AsRef<str>) -> Result<()>

Remove a file from the package’s meta.far.

Errors

Will return an error if the file is not already in the meta.far

pub fn add_file_as_blob( &mut self, at_path: impl AsRef<str>, file: impl AsRef<str>, ) -> Result<()>

Add a file to the package as a blob itself.

Errors

Will return an error if the path for the file is already being used. Will return an error if any special package metadata paths are used.

pub fn remove_blob_file(&mut self, at_path: impl AsRef<str>) -> Result<()>

Remove a file currently in the package as a blob

Errors

Will return an error if the file is not already in the package contents

pub fn add_contents_as_blob<C: AsRef<[u8]>>( &mut self, at_path: impl AsRef<str>, contents: C, gendir: impl AsRef<Path>, ) -> Result<()>

Write the contents to a file, and add that file as a blob at the given path within the package.

pub fn add_contents_to_far<C: AsRef<[u8]>>( &mut self, at_path: impl AsRef<str>, contents: C, gendir: impl AsRef<Path>, ) -> Result<()>

Write the contents to a file, and add that file to the metafar at the given path within the package.

pub fn overwrite_subpackages(&mut self, overwrite_subpackages: bool)

Specify whether new additions of a subpackage that have already been added should overwrite, or fail

pub fn add_subpackage( &mut self, url: &RelativePackageUrl, package_hash: Hash, package_manifest_path: PathBuf, ) -> Result<()>

Helper fn to include a subpackage into this package.

pub fn name(&mut self, name: impl AsRef<str>)

Set the name of the package.

pub fn published_name(&mut self, published_name: impl AsRef<str>)

Set a different name for the package to be published by (and to be included in the generated PackageManifest), than the one embedded in the package itself.

pub fn repository(&mut self, repository: impl AsRef<str>)

Set a repository for the package to be included in the generated PackageManifest.

pub fn read_contents_from_far(&self, file_path: &str) -> Result<Vec<u8>>

Read the contents of a file already added to the builder’s meta.far.

pub fn build( self, gendir: impl AsRef<Path>, metafar_path: impl AsRef<Path>, ) -> Result<PackageManifest>

Build the package, using the specified dir, returning the PackageManifest.

If a path for the manifest was specified, the PackageManifest will also be written to there.

The gendir param is assumed to be a path to folder which is only used by this package’s creation, so this fn does not try to create paths within it that are unique across different packages.