miden-assembly 0.22.2

Miden VM assembly language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use alloc::{sync::Arc, vec::Vec};

use miden_assembly_syntax::{Library, library::ModuleInfo};
use miden_core::mast::MastForest;
use miden_mast_package::Package;
use miden_project::Linkage;
/// Prefer to use [`miden_project::Linkage`], as this will be removed in a future release
pub use miden_project::Linkage as LinkLibraryKind;

/// Represents an assembled module or modules to use when resolving references while linking,
/// as well as the method by which referenced symbols will be linked into the assembled MAST.
#[derive(Clone)]
pub struct LinkLibrary {
    /// The MAST of this library
    pub mast: Arc<MastForest>,
    /// Metadata about the modules and symbols available in the linked forest
    pub module_infos: Vec<ModuleInfo>,
    /// How to link against this library
    pub linkage: Linkage,
}

impl LinkLibrary {
    /// Construct a [LinkLibrary] from a [miden_mast_package::Package]
    pub fn from_package(package: Arc<Package>) -> Self {
        let mast = package.mast.mast_forest().clone();
        let module_infos = package
            .mast
            .module_infos()
            .map(|mut mi| {
                mi.set_version(package.version.clone());
                mi
            })
            .collect();
        Self {
            mast,
            module_infos,
            linkage: Linkage::Dynamic,
        }
    }

    pub(crate) fn from_library(library: &Library) -> Self {
        let mast = library.mast_forest().clone();
        let module_infos = library.module_infos().collect();
        Self {
            mast,
            module_infos,
            linkage: Linkage::Dynamic,
        }
    }

    /// Modify the linkage of this library
    pub fn with_linkage(mut self, linkage: Linkage) -> Self {
        self.linkage = linkage;
        self
    }
}