Struct LibraryManifest 

pub struct LibraryManifest {
    pub lib_url: Url,
    pub metadata: MetaData,
    pub locators: BTreeMap<Url, ImplementationLocator>,
    pub source_urls: BTreeMap<String, Url>,
}

LibraryManifest describes the contents of a Library that can be referenced from a flow It is provided by libraries to help load and/or find implementations of processes

Fields

lib_url: Url

the Url that this library implements

metadata: MetaData

metadata about a flow with author, version and usual fields

locators: BTreeMap<Url, ImplementationLocator>

the locators map a lib reference to a ImplementationLocator for a function or flow that can be used to load it or reference it.

source_urls: BTreeMap<String, Url>

source_files is a map of: Key: lib reference for functions or flows, as used in locators Value: Url where the source file it was derived from is located

Implementations

impl LibraryManifest

pub fn new(lib_url: Url, metadata: MetaData) -> Self

Create a new, empty, LibraryManifest with the provided Metadata

pub fn load( provider: &Arc<dyn Provider>, lib_manifest_url: &Url, ) -> Result<(LibraryManifest, Url)>

load a LibraryManifest from lib_manifest_url, using provider to fetch the contents

Errors

Returns an error if:

• The provided lib_manifest_url Url cannot be resolved
• The provider cannot fetch the contents from the resolved url
• The fetched contents cannot be converted to a valid Utf8 String
• The Fetched Utf8 String contents of the Url are not a valid LibraryManifest

pub fn add_locator( &mut self, implementation_path_relative: &str, lib_reference_path: &str, ) -> Result<()>

Add a locator to the LibraryManifest to allow resolving “lib://” lib reference Urls for functions or flows to where the implementation resides within the library directory structure (relative to the lib root). Also add it to the list of source files lookups in the manifest if compiling with debug info

Errors

Returns error if:

• implementation_path_relative cannot be used to form a Url referencing a file
• lib_reference_path cannot be used to form a Url referencing a library

pub fn remove_locator(&mut self, locator_url: &Url)

Remove a locator from the manifest by its library URL.

If the locator is a RelativePath, the corresponding entry in source_urls is also removed. If the locator does not exist, this method does nothing.

pub fn manifest_filename(base_dir: &Path) -> PathBuf

Given an output directory, return a PathBuf to the json format manifest that should be generated inside it

pub fn write_json(&self, json_manifest_filename: &Path) -> Result<()>

Generate a manifest for the library in JSON format

Errors

Returns an error if:

• File cannot be created at Path json_manifest_filename
• Contents of manifest cannot be written to file at json_manifest_filename

Trait Implementations

impl Clone for LibraryManifest

fn clone(&self) -> LibraryManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for LibraryManifest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LibraryManifest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LibraryManifest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.