rhaj/rhai_engine/rhaibook/rust/packages/builtin.md

Built-In Packages

{{#include ../../links.md}}

Engine::new creates an [Engine] with the StandardPackage loaded.

Engine::new_raw creates an [Engine] with no [package] loaded.

Package	Description	In Core	In Standard
LanguageCorePackage	core functions for the Rhai language	yes	yes
ArithmeticPackage	arithmetic operators (e.g. +, -, *, /) for numeric types that are not built in (e.g. u16)	yes	yes
BitFieldPackage	basic [bit-field] functions	no	yes
BasicIteratorPackage	numeric ranges (e.g. range(1, 100, 5)), iterators for [arrays], [strings], [bit-fields] and [object maps]	yes	yes
LogicPackage	logical and comparison operators (e.g. ==, >) for numeric types that are not built in (e.g. u16)	no	yes
BasicStringPackage	basic string functions (e.g. print, debug, len) that are not built in	yes	yes
BasicTimePackage	basic time functions (e.g. [timestamps], not available under [no_time] or [no_std])	no	yes
MoreStringPackage	additional string functions, including converting common types to string	no	yes
BasicMathPackage	basic math functions (e.g. sin, sqrt)	no	yes
BasicArrayPackage	basic [array] functions (not available under [no_index])	no	yes
BasicBlobPackage	basic [BLOB] functions (not available under [no_index])	no	yes
BasicMapPackage	basic [object map] functions (not available under [no_object])	no	yes
BasicFnPackage	basic methods for [function pointers]	yes	yes
DebuggingPackage	basic functions for [debugging][debugger] (requires [debugging])	yes	yes
CorePackage	basic essentials	yes	yes
StandardPackage	standard library (default for Engine::new)	no	yes

CorePackage

If only minimal functionalities are required, register the CorePackage instead.

use rhai::Engine;
use rhai::packages::{Package, CorePackage};

let mut engine = Engine::new_raw();
let package = CorePackage::new();

// Register the package into the 'Engine'.
package.register_into_engine(&mut engine);