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 name(self) -> Symbol<'base>

Returns the name of this module.

pub fn parent(self) -> Option<Self>

Returns the parent of this module.

pub fn extend<'global>(self, _: Global<'global>) -> Module<'global>

Extend the lifetime of this module; if self has originally been created by calling some Julia function the lifetime will be limited to the frame the function is called with. This can be extended to the lifetime of Global by calling this method.

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 unsafe fn set_global<'frame, N>(
    self,
    name: N,
    value: Value<'frame, 'static>
) -> Value<'base, 'static> where
    N: TemporarySymbol, 

Set a global value in this module. This is unsafe because if another global value was previously assigned to this name, this previous value can become eligible for garbage collection. Don't use the previous value after calling this method.

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

Set a constant in this module.

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(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, 'data> Debug for Module<'frame>

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

Formats the value using the given formatter.

impl<'base> Into<Value<'base, 'static>> for Module<'base>

fn into(self) -> Value<'base, 'static>

Performs the conversion.

impl<'frame> JuliaType for Module<'frame>

unsafe fn julia_type() -> *mut jl_datatype_t

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

unsafe fn julia_typecheck(t: DataType<'_>) -> bool

impl<'frame> ValidLayout for Module<'frame>

unsafe fn valid_layout(v: Value<'_, '_>) -> bool