Struct CollectionManifest 

#[non_exhaustive]
pub struct CollectionManifest {
    pub schema_version: u32,
    pub collection_id: Uuid,
    pub version: String,
    pub parent: Option<Hash>,
    pub changelog: Option<String>,
    pub entries: Vec<CollectionEntry>,
    pub package: Option<PackageProfile>,
    pub signature: Option<String>,
    pub public_key: Option<String>,
    pub metadata: Option<PackageMetadata>,
}

Immutable description of a collection version.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema_version: u32

collection_id: Uuid

version: String

parent: Option<Hash>

changelog: Option<String>

entries: Vec<CollectionEntry>

package: Option<PackageProfile>

signature: Option<String>

public_key: Option<String>

metadata: Option<PackageMetadata>

Application-specific metadata (optional).

Implementations

impl CollectionManifest

pub fn new(collection_id: Uuid, version: impl Into<String>) -> Self

pub fn validate(&self) -> Result<()>

Errors

Returns an error when the schema, version, paths, dependencies, or duplicate entries are invalid.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Errors

Returns an error when the manifest is invalid or cannot be serialized.

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self>

Errors

Returns an error when the manifest cannot be decoded or is invalid.

pub fn unsigned_bytes(&self) -> Result<Vec<u8>>

Serialize the manifest without its signature.

The public key remains part of this representation so changing the signer changes the manifest identity.

Errors

Returns an error when the manifest is invalid or cannot be serialized.

pub fn sign(&mut self, signing_key: &SigningKey) -> Result<()>

Sign the manifest with an Ed25519 maintainer key.

The signature is encoded as lowercase hexadecimal in the manifest.

Errors

Returns an error when the manifest is invalid or cannot be serialized.

pub fn verify_signature(&self) -> Result<()>

Verify the manifest’s embedded Ed25519 signature.

Unsigned manifests have no signature to verify and return Ok(()); a partially signed manifest is rejected.

Errors

Returns an error when signature metadata is malformed or verification fails.

pub fn version_ordering(&self, other_manifest: &Self) -> Result<Ordering>

Compare this manifest’s semver version with another manifest.

Errors

Returns an error when either manifest contains an invalid semver version.

pub fn is_upgrade_from(&self, other: &Self) -> Result<bool>

Return whether this manifest is a newer version than another manifest.

Errors

Returns an error when either manifest contains an invalid semver version.

pub fn dependencies_satisfied( &self, available: &BTreeMap<Uuid, Version>, ) -> Result<bool>

Check whether all package dependencies are available.

Errors

Returns an error when package metadata or dependency requirements are invalid.

pub fn content_id(&self) -> Result<Hash>

Errors

Returns an error when the manifest cannot be serialized.

pub fn blob_id(&self) -> Result<Hash>

Return the content hash of the serialized manifest blob.

This differs from Self::content_id for signed manifests because the signature is intentionally excluded from the logical manifest ID.

Errors

Returns an error when the manifest is invalid or cannot be serialized.

Trait Implementations

impl Clone for CollectionManifest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionManifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionManifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CollectionManifest

impl PartialEq for CollectionManifest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CollectionManifest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CollectionManifest