Struct kdl_script::types::DefinitionGraph

pub struct DefinitionGraph { /* private fields */ }

A Dependency Graph of all the type/function definitions.

Implementations

impl DefinitionGraph

pub fn definitions(
    &self,
    funcs: impl IntoIterator<Item = FuncIdx>
) -> Vec<Definition>

Get the exact list of forward-declares and definitions to emit the program!

Note that the recommendations are extremely agnostic to the target language and will generally recommend you forward-declare or define a lot of types that need no such thing in basically every language.

For instance with a definition like:

struct "SelfReferential" {
    me "Option<&SelfReferential>"
    val "u32"
}

(Generics aren’t currently supported, this is just easier to express.)

You will get recommended something like:

1. Define u32
2. Forward-declare SelfReferential
3. Forward-declare &SelfReferential
4. Define Option<&SelfReferential>
5. Define SelfReferential
6. Define &SelfReferential

Which contains a lot of things that are nonsensical in basically every language! That’s ok! Just ignore the nonsensical recommendations like “declare a primitive” or “forward-declare a reference” if they aren’t necessary in your language!

A Rust backend would only need to emit 5 (and maybe 4 if it’s not Real Option).

A C backend would only need to emit 2 and 5 (and maybe 4 if it’s not Real Option).

Trait Implementations

impl Clone for DefinitionGraph

fn clone(&self) -> DefinitionGraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DefinitionGraph

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

Formats the value using the given formatter.