Struct DarManifest 

pub struct DarManifest { /* private fields */ }

Represents a manifest file found inside dar files.

A dar manifest file contains the following fields:

• Manifest-Version: the version of the manifest file (optional, defaults to Unknown)
• Created-By: describes what created the dar file containing this manifest file (optional, default to empty string)
• Main-Dalf: the name of the main dalf file within the dar file (mandatory)
• Dalfs: a comma separated list of dalf files within this dar file (mandatory)
• Format: the format of the dalf files in this dar archive (mandatory)
• Encryption: the encryption type of the dalf files in this dar archive (mandatory)

Note that the main dalf file MUST also be provided in the Dalfs attribute and so that attribute will never be empty.

Implementations

impl DarManifest

pub fn new( version: impl Into<DarManifestVersion>, created_by: impl Into<String>, dalf_main: impl Into<String>, dalf_dependencies: Vec<String>, format: impl Into<DarManifestFormat>, encryption: impl Into<DarEncryptionType>, ) -> Self

Crate a DarManifest.

pub fn new_implied( dalf_main: impl Into<String>, dalf_dependencies: Vec<String>, ) -> Self

Create a DarManifest from the supplied main and dalf_dependencies dalf files.

pub fn parse(manifest: &str) -> DamlLfResult<Self>

Create a DarManifest from the supplied manifest string.

Note that all dalf names are stripped of all whitespace.

Errors

If the provided manifest string cannot be parsed into newline key: value pairs then IoError will be returned.

If the parsed manifest has an invalid format (such as missing a mandatory key) then DarParseError will be returned.

Examples

let manifest_str = "
           Main-Dalf: A.dalf
           Dalfs: A.dalf
           Format: daml-lf
           Encryption: non-encrypted";
let manifest = DarManifest::parse(&manifest_str[..])?;
assert_eq!(DarManifestVersion::Unknown, manifest.version());
assert_eq!("", manifest.created_by());
assert_eq!("A.dalf", manifest.dalf_main());
assert_eq!(&Vec::<String>::new(), manifest.dalf_dependencies());
assert_eq!(DarManifestFormat::DamlLf, manifest.format());
assert_eq!(DarEncryptionType::NotEncrypted, manifest.encryption());

pub fn render(&self) -> String

Render this DarManifest

pub const fn version(&self) -> DarManifestVersion

The version of the manifest.

pub fn created_by(&self) -> &str

Describes who created the dar file which contains this manifest file.

pub fn dalf_main(&self) -> &str

The name of the main dalf archive within the dar file containing this manifest file.

pub const fn dalf_dependencies(&self) -> &Vec<String>

A list of names of the dalf_dependencies dalf archives within the dar file containing this manifest file.

pub const fn format(&self) -> DarManifestFormat

The format of the dar which contains this manifest file.

pub const fn encryption(&self) -> DarEncryptionType

The encryption type of the dar which contains this manifest file.

Trait Implementations

impl Clone for DarManifest

fn clone(&self) -> DarManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DarManifest

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

Formats the value using the given formatter.