daml-codegen 0.3.0

Daml GRPC Ledger API Code Generator
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
57
58
59
60
61
62
63
64
65
66

use daml_lf::DarFile;

use crate::error::DamlCodeGenResult;
use crate::generator::ModuleOutputMode;
use crate::generator::combined::generate_archive_combined;
use crate::generator::generator_options::RenderMethod;
use crate::generator::module_matcher::ModuleMatcher;
use crate::generator::separate::generate_archive_separate;

/// Code generator which is designed to be called from `build.rs` files.
///
/// To use the [`daml_codegen`] function you must first import the `daml` crate and specify feature `codegen`:
///
/// ```toml
/// [dependencies]
/// daml = { version = "0.3.0", features = [ "codegen" ] }
/// ```
///
/// In your `build.rs` main function invoke the [`daml_codegen`] function for a `dar` file and specify where the
/// generated src code should be created:
///
/// ```no_run
/// use daml_codegen::generator::{daml_codegen, ModuleOutputMode, RenderMethod};
/// let method = RenderMethod::Full;
/// let mode = ModuleOutputMode::Combined;
/// daml_codegen("MyModel.dar", "src/autogen", &[], method, mode).unwrap();
/// ```
///
/// In the example above we used [`RenderMethod::Full`] to indicate that we want to render Rust types without
/// intermediate annotations (such as [`DamlTemplate`]) and [`ModuleOutputMode::Combined`] to combine all Daml modules
/// in a single Rust src file.
///
/// [`DamlTemplate`]: https://docs.rs/daml-derive/0.3.0/daml_derive/attr.DamlTemplate.html
pub fn daml_codegen(
    dar_file: &str,
    output_path: &str,
    module_filter_regex: &[&str],
    quote_method: RenderMethod,
    module_output_mode: ModuleOutputMode,
) -> DamlCodeGenResult<()> {
    println!("cargo:rerun-if-changed={dar_file}");
    daml_codegen_internal(dar_file, output_path, module_filter_regex, quote_method, module_output_mode)
}

#[doc(hidden)]
pub fn daml_codegen_internal(
    dar_file: &str,
    output_path: &str,
    module_filter_regex: &[&str],
    render_method: RenderMethod,
    module_output_mode: ModuleOutputMode,
) -> DamlCodeGenResult<()> {
    let dar = DarFile::from_file(dar_file)?;
    dar.apply(|archive| {
        let module_matcher = ModuleMatcher::new(module_filter_regex)?;
        match module_output_mode {
            ModuleOutputMode::Separate => {
                generate_archive_separate(archive, output_path.as_ref(), &module_matcher, &render_method)?;
            },
            ModuleOutputMode::Combined => {
                generate_archive_combined(archive, output_path.as_ref(), &module_matcher, &render_method)?;
            },
        }
        Ok(())
    })?
}