Skip to main content

Module

Struct Module 

Source
pub struct Module {
    pub manifest: Arc<Manifest>,
    pub root: PathBuf,
    pub lockfile_scope: Vec<DependencyName>,
}
Expand description

A WDL module, pairing its parsed Manifest, the directory on disk that holds the module.json file, and the lockfile scope that locates the module’s entry within a top-level lockfile.

Fields§

§manifest: Arc<Manifest>

The parsed manifest.

§root: PathBuf

The directory containing the module.json file.

§lockfile_scope: Vec<DependencyName>

The chain of dependency names from the top-level consumer to this module. Empty for the top-level consumer itself. A dependency coffeeshop brought in by cafe_menu has scope [cafe_menu].

Implementations§

Source§

impl Module

Source

pub fn new(manifest: Arc<Manifest>, root: PathBuf) -> Self

Builds a top-level Module from a manifest and its root directory. The lockfile scope is empty.

Source

pub fn id(&self) -> ModuleId

Returns this module’s identity, combining its root directory and lockfile scope.

Source

pub fn load_from_path(path: &Path) -> Result<Self, ManifestError>

Reads module.json from path and constructs a top-level Module with path as the root.

Source

pub fn resolve_local_path(&self, path: &Path) -> PathBuf

Returns path joined to root when path is relative, or path itself when it is already absolute.

Source

pub fn child( &self, name: DependencyName, manifest: Arc<Manifest>, root: PathBuf, ) -> Self

Returns a child Module in the lockfile scope below this one, extending the scope by name.

Trait Implementations§

Source§

impl Clone for Module

Source§

fn clone(&self) -> Module

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Module

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.