Crate zula_core

source ·
Expand description

zula-core contains the core functionality of the zula shell, and is required for writing plugins. This api is experimental, and may introduce breaking changes.

Plugin Guide

To create a plugin, first initialize a library crate.

cargo new my_plugin --lib

Set the crate type to cdylib, and add zula-core as a dependency.

crate-type = ["cdylib"]

zula-core = "4.0.0"

Import the Plugin trait and implement it on your plugin type.

use zula_core::{Plugin, ShellState};
use std::error::Error;

pub struct MyPlugin;

impl Plugin for MyPlugin {
    //since this function is called across abi boundaries, its important to include no_mangle so
    //that rustc leaves the symbol as-is and can be called properly.
    fn init(&self) -> Box<dyn Plugin> {
    fn name(&self) -> &str {
    fn call(&self, state: *mut ShellState) -> Result<(), Box<dyn Error>> {
        println!("Hello, plugin!");

Run cargo build --release to build your plugin. The library file should be in target/release/lib<name>.so. This is the file that you’ll put in your plugins folder.

Thats it! Run zula cfg inside zula to check that its loaded, and run plugin.<name> to use it. Due to weird ownership relationships, call has to take a raw pointer, so use it responsibly.


  • Holds configuration info.
  • Represents a plugin object. Not very useful outside of internal functions.
  • The core shell state object. This api is WIP, and may become more locked down in the future.


  • The zula shell error type. All errors can be converted to the Opaque variant.


  • The plugin trait that defines how a plugin object acts.