Struct Cmajor 

pub struct Cmajor { /* private fields */ }

The Cmajor library.

Implementations

impl Cmajor

pub fn new() -> Self

Create a new instance of the Cmajor library.

Panics

Panics if the library fails to load.

pub fn new_from_path( path_to_library: impl AsRef<Path>, ) -> Result<Self, LibraryError>

Load the Cmajor library at the given path.

pub fn new_from_env() -> Result<Self, LibraryError>

Load the Cmajor library from the path specified at the CMAJOR_LIB_PATH environment variable.

pub fn version(&self) -> &str

Returns the version of the Cmajor library.

pub fn parse( &self, cmajor_program: impl AsRef<str>, ) -> Result<Program, ParseError>

Parse a Cmajor program.

pub fn engine_types(&self) -> impl Iterator<Item = EngineType> + '_

Returns the available engine types.

pub fn create_default_engine(&self) -> EngineBuilder

Create the default engine type (LLVM JIT).

pub fn create_engine(&self, engine_type: EngineType) -> EngineBuilder

Create a new engine of the given type.

Trait Implementations

impl Default for Cmajor

fn default() -> Self

Returns the “default value” for a type.