pub struct PackageManifest(/* private fields */);

Implementations§

source§

impl PackageManifest

source

pub const META_FAR_BLOB_PATH: &'static str = "meta/"

Blob path used in package manifests to indicate the meta.far.

source

pub fn blobs(&self) -> &[BlobInfo]

source

pub fn subpackages(&self) -> &[SubpackageInfo]

source

pub fn into_blobs(self) -> Vec<BlobInfo>

source

pub fn into_blobs_and_subpackages(self) -> (Vec<BlobInfo>, Vec<SubpackageInfo>)

Returns the current packages blobs and subpackages.

source

pub fn name(&self) -> &PackageName

source

pub async fn archive( self, root_dir: impl AsRef<Path>, out: impl Write ) -> Result<(), PackageManifestError>

Write a package archive into the out file. The source files are relative to the root_dir directory.

source

pub fn package_path(&self) -> PackagePath

source

pub fn repository(&self) -> Option<&str>

source

pub fn set_repository(&mut self, repository: Option<String>)

source

pub fn package_url(&self) -> Result<Option<UnpinnedAbsolutePackageUrl>>

source

pub fn hash(&self) -> Hash

Returns the merkle root of the meta.far.

Panics

Panics if the PackageManifest is missing a “meta/” entry

source

pub fn from_blobs_dir( blobs_dir: &Path, meta_far_hash: Hash, out_manifest_dir: &Path ) -> Result<Self, PackageManifestError>

Create a PackageManifest and populate a manifest directory given a blobs directory and the top level meta.far hash.

The blobs_dir directory must be a flat file that contains all the package blobs. The out_manifest_dir will be a flat file populated with JSON representations of PackageManifests corresponding to the subpackages.

source

pub fn from_archive( archive_path: &Path, blobs_dir: &Path, out_manifest_dir: &Path ) -> Result<Self, PackageManifestError>

Extract the package blobs from archive_path into the blobs_dir directory and extracts all the JSON representations of the subpackages’ PackageManifests and top level PackageManifest into out_manifest_dir.

Returns an in-memory PackageManifest for these files.

source

pub fn try_load_from(manifest_path: impl AsRef<Utf8Path>) -> Result<Self>

source

pub fn from_reader( manifest_path: impl AsRef<Utf8Path>, reader: impl Read ) -> Result<Self>

source

pub fn write_with_relative_paths( self, path: impl AsRef<Utf8Path> ) -> Result<Self>

Trait Implementations§

source§

impl Clone for PackageManifest

source§

fn clone(&self) -> PackageManifest

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 PackageManifest

source§

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

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

impl PartialEq for PackageManifest

source§

fn eq(&self, other: &PackageManifest) -> 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 PackageManifest

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 PackageManifest

source§

impl StructuralEq for PackageManifest

source§

impl StructuralPartialEq for PackageManifest

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