Struct kaze::Context

#[must_use]pub struct Context<'a> { /* fields omitted */ }

A top-level container/owner object for a Module graph.

A Context owns all parts of a module graph, and provides an API for creating Module objects.

Examples

use kaze::*;

let c = Context::new();

let m = c.module("MyModule");
m.output("out", m.input("in", 1));

Methods

impl<'a> Context<'a>

pub fn new() -> Context<'a>

Creates a new, empty Context.

Examples

use kaze::*;

let c = Context::new();

pub fn module<S: Into<String>>(&'a self, name: S) -> &Module

Creates a new Module called name in this Context.

Conventionally, name should be CamelCase, though this is not enforced.

Panics

Panics if a Module with the same name already exists in this Context.

Examples

use kaze::*;

let c = Context::new();

let my_module = c.module("MyModule");
let another_mod = c.module("AnotherMod");

The following example panics by creating a Module with the same name as a previously-created Module in the same Context:

use kaze::*;

let c = Context::new();

let _ = c.module("A"); // Unique name, OK
let _ = c.module("B"); // Unique name, OK

let _ = c.module("A"); // Non-unique name, panic!

pub fn modules(&'a self) -> Ref<BTreeMap<String, &'a Module<'a>>>

Immutably borrows this Context's Modules.

This is primarily useful for iterating over every Module in this Context when generating code.

Examples

use kaze::*;

let c = Context::new();

let my_module = c.module("MyModule");
let another_mod = c.module("AnotherMod");

assert_eq!(c.modules().len(), 2);