pub struct PackageBuildManifest(/* private fields */);
Expand description

A PackageBuildManifest lists the files that should be included in a Fuchsia package. Both external_contents and far_contents are maps from package resource paths in the to-be-created package to paths on the local filesystem. Package resource paths start with “meta/” if and only if they are in far_contents.

Implementations§

source§

impl PackageBuildManifest

source

pub fn from_external_and_far_contents( external_contents: BTreeMap<String, String>, far_contents: BTreeMap<String, String> ) -> Result<Self, PackageBuildManifestError>

Creates a PackageBuildManifest from external and far contents maps.

external_contents is a map from package resource paths to their locations on the host filesystem. These are the files that will be listed in meta/contents. Resource paths in external_contents must not start with meta/ or be exactly meta. Resource paths must not have file/directory collisions, e.g. [“foo”, “foo/bar”] have a file/directory collision at “foo”, or they will be rejected. far_contents is a map from package resource paths to their locations on the host filesystem. These are the files that will be included bodily in the package meta.far archive. Resource paths in far_contents must start with meta/.

Examples
let external_contents = btreemap! {
    "lib/mylib.so".to_string() => "build/system/path/mylib.so".to_string()
};
let far_contents = btreemap! {
    "meta/my_component_manifest.cm".to_string() =>
        "other/build/system/path/my_component_manifest.cm".to_string()
};
let creation_manifest =
    PackageBuildManifest::from_external_and_far_contents(external_contents, far_contents)
        .unwrap();
source

pub fn from_json<R: Read>(reader: R) -> Result<Self, PackageBuildManifestError>

Deserializes a PackageBuildManifest from versioned json.

Examples
let json_string = r#"
{
  "version": "1",
  "content": {
    "/": {
      "lib/mylib.so": "build/system/path/mylib.so"
    },
   "/meta/": {
     "my_component_manifest.cml": "other/build/system/path/my_component_manifest.cml"
   }
}"#;
let creation_manifest = PackageBuildManifest::from_json(json_string.as_bytes());
source

pub fn from_dir( root: impl AsRef<Path> ) -> Result<Self, PackageBuildManifestError>

source

pub fn from_pm_fini<R: BufRead>( reader: R ) -> Result<Self, PackageBuildManifestError>

Create a PackageBuildManifest from a pm-build-style Fuchsia INI file (fini). fini is a simple format where each line is an entry of $PKG_PATH=$HOST_PATH. This copies the parsing algorithm from pm, where:

  • The $PKG_PATH is the string up to the first equals sign.
  • If there is a duplicate entry, check if the two entries have the same file contents. If not, error out.
  • Only check if the files exist upon duplicate entry.
  • Ignores lines without an ‘=’ in it.

Note: This functionality exists only to ease the migration from pm build. This will be removed once there are no more users of pm build-style manifests.

Examples
let fini_string = "\
    lib/mylib.so=build/system/path/mylib.so\n\
    meta/my_component_manifest.cml=other/build/system/path/my_component_manifest.cml\n";

let creation_manifest = PackageBuildManifest::from_pm_fini(fini_string.as_bytes()).unwrap();
source

pub fn external_contents(&self) -> &BTreeMap<String, String>

external_contents lists the blobs that make up the meta/contents file

source

pub fn far_contents(&self) -> &BTreeMap<String, String>

far_contents lists the files to be included bodily in the meta.far

Trait Implementations§

source§

impl Clone for PackageBuildManifest

source§

fn clone(&self) -> PackageBuildManifest

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PackageBuildManifest

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for PackageBuildManifest

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for PackageBuildManifest

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for PackageBuildManifest

source§

impl StructuralEq for PackageBuildManifest

source§

impl StructuralPartialEq for PackageBuildManifest

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more