Struct ocaml_gen::Env

pub struct Env { /* private fields */ }

The environment at some point in time during the declaration of OCaml bindings. It ensures that types cannot be declared twice, and that types that are renamed and/or relocated into module are referenced correctly.

Implementations

impl Env

pub fn new() -> Self

Creates a new environment.

pub fn new_type(&mut self, ty: u128, name: &'static str)

Declares a new type. If the type was already declared, this will panic.

Panics

The function will panic if the type was already declared.

pub fn get_type(&self, ty: u128, name: &str) -> (String, bool)

Retrieves a type that was declared previously. A boolean indicates if the type is being aliased.

Panics

The function will panic if the type was not declared previously.

pub fn add_alias(&mut self, ty: u128, alias: &'static str)

Adds a new alias for the current scope (module).

Panics

The function will panic if the alias was already declared.

pub fn new_module(&mut self, mod_name: &'static str) -> String

Create a module and enters it.

Panics

This function will panic if the module was already declared, or if the module name is not following the OCaml guidelines.

pub fn nested(&self) -> usize

how deeply nested are we currently? (default is 0)

pub fn parent(&mut self) -> String

called when we exit a module

pub fn root(&mut self) -> String

you can call this to go back to the root and finalize the generation

Trait Implementations

impl Debug for Env

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

Formats the value using the given formatter.

impl Default for Env

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Env

fn drop(&mut self)

This makes sure that we close our OCaml modules (with the keyword end).