zsh-sys

This crate provides low-level FFI bindings to the ZSH API. It allows users to interact with ZSH internals and create ZSH modules in Rust. This crate is intended for advanced users who want to have more control over their ZSH modules and are comfortable working with unsafe code.

Quick Start

Add zsh-sys as your dependency in Cargo.toml

cargo add zsh-sys

Usage

Raw bindings to zsh's core headers are re-exported at the crate root:

use zsh::{Module, Builtin};

Bindings for zsh's bundled modules are split behind feature flags and exposed under namespaced submodules (boot, setup, features, enables, cleanup, finish):

// requires the `zle` feature
use zsh::zle::complist;

unsafe { complist::setup(module) };

Most users should prefer the higher-level zsh-module crate, which wraps these bindings in a safe API.

Features

• zle — bindings for Src/Zle (types, functions, and the following modules: zutil, compctl, complist, computil, zleparameter)
• builtins — bindings for Src/Builtins (rlimits, sched)
• modules — bindings for Src/Modules (datetime, langinfo, parameter, termcap, terminfo, zutil)
• all (default) — enables all of the above

Credits

License