Struct jlrs::value::module::Module

#[repr(transparent)]pub struct Module<'base>(_, _);

Functionality in Julia can be accessed through its module system. You can get a handle to the three standard modules, Main, Base, and Core and access their submodules through them. If you include your own Julia code with Julia::include, its contents are made available relative to Main.

This struct implements JuliaTypecheck and Cast. It can be used in combination with DataType::is and Value::is; if the check returns true the Value can be cast to Module.

Implementations

impl<'base> Module<'base>

pub fn main(_: Global<'base>) -> Self

Returns a handle to Julia's Main-module. If you include your own Julia code by calling Julia::include, handles to functions, globals, and submodules defined in these included files are available through this module.

pub fn core(_: Global<'base>) -> Self

Returns a handle to Julia's Core-module.

pub fn base(_: Global<'base>) -> Self

Returns a handle to Julia's Base-module.

pub fn submodule<N>(self, name: N) -> JlrsResult<Self> where
    N: TemporarySymbol, 

Returns the submodule named name relative to this module. You have to visit this level by level: you can't access Main.A.B by calling this function with "A.B", but have to access A first and then B.

Returns an error if the submodule doesn't exist.

pub fn global<N>(self, name: N) -> JlrsResult<Value<'base, 'static>> where
    N: TemporarySymbol, 

Returns the global named name in this module. Returns an error if the global doesn't exist.

pub fn function<N>(self, name: N) -> JlrsResult<Value<'base, 'static>> where
    N: TemporarySymbol, 

Returns the function named name in this module. Note that all globals defined within the module will be successfully resolved into a function; Julia will throw an exception if you try to call something that isn't a function. This means that this method is just an alias for Module::global.

Returns an error if th function doesn't exist.

Trait Implementations

impl<'frame, 'data> Cast<'frame, 'data> for Module<'frame>

type Output = Self

fn cast(value: Value<'frame, 'data>) -> JlrsResult<Self::Output>

unsafe fn cast_unchecked<'fr, 'da>(value: Value<'frame, 'data>) -> Self::Output

impl<'base> Clone for Module<'base>

fn clone(&self) -> Module<'base>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'base> Copy for Module<'base>

impl<'frame> JuliaTypecheck for Module<'frame>

unsafe fn julia_typecheck(t: DataType) -> bool