rune/lib.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
//! <img alt="rune logo" src="https://raw.githubusercontent.com/rune-rs/rune/main/assets/icon.png" />
//! <br>
//! <a href="https://github.com/rune-rs/rune"><img alt="github" src="https://img.shields.io/badge/github-rune--rs/rune-8da0cb?style=for-the-badge&logo=github" height="20"></a>
//! <a href="https://crates.io/crates/rune"><img alt="crates.io" src="https://img.shields.io/crates/v/rune.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20"></a>
//! <a href="https://docs.rs/rune"><img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-rune-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20"></a>
//! <a href="https://discord.gg/v5AeNkT"><img alt="chat on discord" src="https://img.shields.io/discord/558644981137670144.svg?logo=discord&style=flat-square" height="20"></a>
//! <br>
//! Minimum support: Rust <b>1.81+</b>.
//! <br>
//! <br>
//! <a href="https://rune-rs.github.io"><b>Visit the site 🌐</b></a>
//! —
//! <a href="https://rune-rs.github.io/book/"><b>Read the book 📖</b></a>
//! <br>
//! <br>
//!
//! The Rune Language, an embeddable dynamic programming language for Rust.
//!
//! <br>
//!
//! ## Contributing
//!
//! If you want to help out, please have a look at [Open Issues].
//!
//! <br>
//!
//! ## Highlights of Rune
//!
//! * Runs a compact representation of the language on top of an efficient
//! [stack-based virtual machine][support-virtual-machine].
//! * Clean [Rust integration 💻][support-rust-integration].
//! * [Multithreaded 📖][support-multithreading] execution.
//! * [Hot reloading 📖][support-hot-reloading].
//! * Memory safe through [reference counting 📖][support-reference-counted].
//! * [Awesome macros 📖][support-macros] and [Template literals 📖][support-templates].
//! * [Try operators 📖][support-try] and [Pattern matching 📖][support-patterns].
//! * [Structs and enums 📖][support-structs] with associated data and
//! functions.
//! * Dynamic containers like [vectors 📖][support-dynamic-vectors], [objects
//! 📖][support-anon-objects], and [tuples 📖][support-anon-tuples] all with
//! out-of-the-box [serde support 💻][support-serde].
//! * First-class [async support 📖][support-async] with [Generators 📖][support-generators].
//! * Dynamic [instance functions 📖][support-instance-functions].
//! * [Stack isolation 📖][support-stack-isolation] between function calls.
//!
//! <br>
//!
//! ## Rune scripts
//!
//! You can run Rune programs with the bundled CLI:
//!
//! ```text
//! cargo run --bin rune -- run scripts/hello_world.rn
//! ```
//!
//! If you want to see detailed diagnostics of your program while it's running,
//! you can use:
//!
//! ```text
//! cargo run --bin rune -- run scripts/hello_world.rn --dump --trace
//! ```
//!
//! See `--help` for more information.
//!
//! <br>
//!
//! ## Running scripts from Rust
//!
//! > You can find more examples [in the `examples` folder].
//!
//! The following is a complete example, including rich diagnostics using
//! [`termcolor`]. It can be made much simpler if this is not needed.
//!
//! [`termcolor`]: https://docs.rs/termcolor
//!
//! ```no_run
//! use rune::{Context, Diagnostics, Source, Sources, Vm};
//! use rune::termcolor::{ColorChoice, StandardStream};
//! use std::sync::Arc;
//!
//! let context = Context::with_default_modules()?;
//! let runtime = Arc::new(context.runtime()?);
//!
//! let mut sources = Sources::new();
//! sources.insert(Source::memory("pub fn add(a, b) { a + b }")?);
//!
//! let mut diagnostics = Diagnostics::new();
//!
//! let result = rune::prepare(&mut sources)
//! .with_context(&context)
//! .with_diagnostics(&mut diagnostics)
//! .build();
//!
//! if !diagnostics.is_empty() {
//! let mut writer = StandardStream::stderr(ColorChoice::Always);
//! diagnostics.emit(&mut writer, &sources)?;
//! }
//!
//! let unit = result?;
//! let mut vm = Vm::new(runtime, Arc::new(unit));
//!
//! let output = vm.call(["add"], (10i64, 20i64))?;
//! let output: i64 = rune::from_value(output)?;
//!
//! println!("{}", output);
//! # Ok::<_, rune::support::Error>(())
//! ```
//!
//! [in the `examples` folder]: https://github.com/rune-rs/rune/tree/main/examples/examples
//! [Open Issues]: https://github.com/rune-rs/rune/issues
//! [support-anon-objects]: https://rune-rs.github.io/book/objects.html
//! [support-anon-tuples]: https://rune-rs.github.io/book/tuples.html
//! [support-async]: https://rune-rs.github.io/book/async.html
//! [support-dynamic-vectors]: https://rune-rs.github.io/book/vectors.html
//! [support-generators]: https://rune-rs.github.io/book/generators.html
//! [support-hot-reloading]: https://rune-rs.github.io/book/hot_reloading.html
//! [support-instance-functions]: https://rune-rs.github.io/book/instance_functions.html
//! [support-macros]: https://rune-rs.github.io/book/macros.html
//! [support-multithreading]: https://rune-rs.github.io/book/multithreading.html
//! [support-patterns]: https://rune-rs.github.io/book/pattern_matching.html
//! [support-reference-counted]: https://rune-rs.github.io/book/variables.html
//! [support-rust-integration]: https://github.com/rune-rs/rune/tree/main/crates/rune-modules
//! [support-serde]: https://github.com/rune-rs/rune/blob/main/crates/rune-modules/src/json.rs
//! [support-stack-isolation]: https://rune-rs.github.io/book/call_frames.html
//! [support-structs]: https://rune-rs.github.io/book/structs.html
//! [support-templates]: https://rune-rs.github.io/book/template_literals.html
//! [support-try]: https://rune-rs.github.io/book/try_operator.html
//! [support-virtual-machine]: https://rune-rs.github.io/book/the_stack.html
#![no_std]
#![deny(missing_docs)]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_doc_tests)]
#![cfg_attr(rune_nightly, feature(rustdoc_missing_doc_code_examples))]
#![cfg_attr(rune_nightly, deny(rustdoc::missing_doc_code_examples))]
#![allow(clippy::enum_variant_names)]
#![allow(clippy::needless_doctest_main)]
#![allow(clippy::too_many_arguments)]
#![allow(clippy::should_implement_trait)]
#![allow(clippy::branches_sharing_code)]
#![allow(clippy::match_like_matches_macro)]
#![allow(clippy::type_complexity)]
#![allow(clippy::module_inception)]
#![allow(clippy::self_named_constructors)]
#![cfg_attr(rune_docsrs, feature(doc_cfg))]
#[cfg(feature = "std")]
#[macro_use]
extern crate std;
// This is here for forward compatibility when we can support allocation-free
// execution.
#[cfg(not(feature = "alloc"))]
compile_error!("The `alloc` feature is currently required to build rune, but will change for parts of rune in the future.");
#[macro_use]
extern crate alloc as rust_alloc;
/// A macro that can be used to construct a [Span][crate::ast::Span] that can be
/// pattern matched over.
///
/// # Examples
///
/// ```
/// use rune::ast::Span;
/// use rune::span;
///
/// let span = Span::new(42, 84);
/// assert!(matches!(span, span!(42, 84)));
/// ```
#[macro_export]
#[doc(hidden)]
macro_rules! span {
($start:expr, $end:expr) => {
$crate::ast::Span {
start: $crate::ast::ByteIndex($start),
end: $crate::ast::ByteIndex($end),
}
};
}
pub mod alloc;
/// Helper prelude for `#[no_std]` support.
pub mod no_std;
#[macro_use]
mod internal_macros;
#[macro_use]
mod exported_macros;
#[macro_use]
pub mod ast;
#[cfg(feature = "fmt")]
pub mod fmt;
#[cfg(feature = "emit")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "emit")))]
#[doc(inline)]
pub use ::codespan_reporting::term::termcolor;
pub(crate) mod any;
pub use self::any::Any;
mod build;
pub use self::build::{prepare, Build, BuildError};
pub mod compile;
#[doc(inline)]
pub use self::compile::{Context, ContextError, Options};
pub mod item;
#[doc(inline)]
pub use self::item::{Item, ItemBuf};
#[doc(hidden)]
mod function_meta;
mod function;
pub mod module;
#[doc(inline)]
pub use self::module::module::Module;
pub mod diagnostics;
#[doc(inline)]
pub use self::diagnostics::Diagnostics;
pub mod hash;
#[doc(inline)]
pub use self::hash::{Hash, ToTypeHash};
#[cfg(feature = "alloc")]
mod hashbrown;
mod params;
pub use self::params::Params;
mod hir;
mod indexing;
pub mod macros;
pub mod modules;
pub mod parse;
pub(crate) mod grammar;
pub mod query;
pub mod runtime;
#[doc(inline)]
pub use self::runtime::{
from_const_value, from_value, to_const_value, to_value, FromValue, Mut, Ref, ToConstValue,
ToValue, TypeHash, Unit, Value, Vm,
};
mod shared;
pub mod source;
#[doc(inline)]
pub use self::source::Source;
#[macro_use]
mod sources;
#[doc(inline)]
pub use self::sources::{SourceId, Sources};
mod worker;
#[doc(hidden)]
pub mod support;
#[cfg(feature = "workspace")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "workspace")))]
pub mod workspace;
/// Macro used to annotate native functions which can be loaded into rune.
///
/// This macro automatically performs the following things:
/// * Rust documentation comments are captured so that it can be used in
/// generated Rune documentation.
/// * The name of arguments is captured to improve documentation generation.
/// * If an instance function is annotated this is detected (if the function
/// receives `self`). This behavior can be forced using
/// `#[rune::function(instance)]` if the function doesn't take `self`.
/// * The name of the function can be set using the `#[rune::function(path =
/// name)]` argument.
/// * An associated function can be specified with the `#[rune::function(path =
/// Type::name)]` argument. If `instance` is specified it is an associated
/// instance function that can be defined externally.
/// * Instance functions can be made a protocol function
/// `#[rune::function(protocol = DISPLAY_FMT)]`.
///
/// # Instance and associated functions
///
/// Instance and associated functions are a bit tricky to declare using
/// `#[rune::function]`, and care must be taken that you understand what needs
/// to be done. So this section is dedicated to documenting the ins and outs of
/// the process.
///
/// Briefly we should mention that instance functions are functions which are
/// associated with a type at runtime. Calling a value like `value.hello()`
/// invokes the `hello` associated function through the instance of `value`. The
/// exact type of `value` will then be used to look up which function to call.
/// They must take some kind of `self` parameter. Meanwhile associated functions
/// are just functions which are associated with a static type. Like
/// `String::new()`. The type `String` must then be in scope, and the function
/// does not take a `self` parameter.
///
/// This is how you declare an instance function which takes `&self` or `&mut
/// self`:
///
/// ```rust
/// # use rune::Any;
/// #[derive(Any)]
/// struct Struct {
/// /* .. */
/// }
///
/// impl Struct {
/// /// Get the length of the `Struct`.
/// #[rune::function]
/// fn len(&self) -> usize {
/// /* .. */
/// # todo!()
/// }
/// }
/// ```
///
/// If a function does not take `&self` or `&mut self`, you must specify that
/// it's an instance function using `#[rune::function(instance)]`. The first
/// argument is then considered the instance the function gets associated with:
///
/// ```rust
/// # use rune::Any;
/// #[derive(Any)]
/// struct Struct {
/// /* .. */
/// }
///
/// /// Get the length of the `Struct`.
/// #[rune::function(instance)]
/// fn len(this: &Struct) -> usize {
/// /* .. */
/// # todo!()
/// }
/// ```
///
/// To declare an associated function which does not receive the type we
/// must specify the path to the function using `#[rune::function(path =
/// Self::<name>)]`:
///
/// ```rust
/// # use rune::Any;
/// #[derive(Any)]
/// struct Struct {
/// /* .. */
/// }
///
/// impl Struct {
/// /// Construct a new [`Struct`].
/// #[rune::function(path = Self::new)]
/// fn new() -> Struct {
/// Struct {
/// /* .. */
/// }
/// }
/// }
/// ```
///
/// Or externally like this:
///
/// ```rust
/// # use rune::Any;
/// #[derive(Any)]
/// struct Struct {
/// /* .. */
/// }
///
/// /// Construct a new [`Struct`].
/// #[rune::function(free, path = Struct::new)]
/// fn new() -> Struct {
/// Struct {
/// /* .. */
/// }
/// }
/// ```
///
/// The first part `Struct` in `Struct::new` is used to determine the type
/// the function is associated with.
///
/// Protocol functions can either be defined in an impl block or externally. To
/// define a protocol externally, you can simply do this:
///
/// ```rust
/// # use rune::Any;
/// # use rune::runtime::{Formatter, VmResult};
/// #[derive(Any)]
/// struct Struct {
/// /* .. */
/// }
///
/// #[rune::function(instance, protocol = DISPLAY_FMT)]
/// fn display_fmt(this: &Struct, f: &mut Formatter) -> VmResult<()> {
/// /* .. */
/// # todo!()
/// }
/// ```
///
/// # Examples
///
/// Defining and using a simple free function:
///
/// ```
/// use rune::{Module, ContextError};
///
/// /// This is a pretty neat function which is called `std::str::to_uppercase("hello")`.
/// #[rune::function]
/// fn to_uppercase(string: &str) -> String {
/// string.to_uppercase()
/// }
///
/// fn module() -> Result<Module, ContextError> {
/// let mut m = Module::new();
/// m.function_meta(to_uppercase)?;
/// Ok(m)
/// }
/// ```
///
/// A free instance function:
///
/// ```
/// use rune::{Module, ContextError};
///
/// /// This is a pretty neat function, which is called like `"hello".to_uppercase()`.
/// #[rune::function(instance)]
/// fn to_uppercase(string: &str) -> String {
/// string.to_uppercase()
/// }
///
/// /// This is a pretty neat function, which is called like `string::to_uppercase2("hello")`.
/// #[rune::function(path = string)]
/// fn to_uppercase2(string: &str) -> String {
/// string.to_uppercase()
/// }
///
/// fn module() -> Result<Module, ContextError> {
/// let mut m = Module::new();
/// m.function_meta(to_uppercase)?;
/// m.function_meta(to_uppercase2)?;
/// Ok(m)
/// }
/// ```
///
/// Regular instance and protocol functions:
///
/// ```
/// use rune::{Any, Module, ContextError};
/// use rune::vm_write;
/// use rune::runtime::{Formatter, VmResult};
/// use rune::alloc::fmt::TryWrite;
///
/// #[derive(Any)]
/// struct String {
/// inner: std::string::String
/// }
///
/// impl String {
/// /// Construct a new string wrapper.
/// #[rune::function(path = Self::new)]
/// fn new(string: &str) -> Self {
/// Self {
/// inner: string.into()
/// }
/// }
///
/// /// Uppercase the string inside of the string wrapper.
/// ///
/// /// # Examples
/// ///
/// /// ```rune
/// /// let string = String::new("hello");
/// /// assert_eq!(string.to_uppercase(), "HELLO");
/// /// ```
/// #[rune::function]
/// fn to_uppercase(&self) -> String {
/// String {
/// inner: self.inner.to_uppercase()
/// }
/// }
///
/// /// Display the string using the [`DISPLAY_FMT`] protocol.
/// ///
/// /// # Examples
/// ///
/// /// ```rune
/// /// let string = String::new("hello");
/// /// assert_eq!(format!("{}", string), "hello");
/// /// ```
/// #[rune::function(protocol = DISPLAY_FMT)]
/// fn display(&self, f: &mut Formatter) -> VmResult<()> {
/// vm_write!(f, "{}", self.inner);
/// VmResult::Ok(())
/// }
/// }
///
/// /// Construct a new empty string.
/// ///
/// /// # Examples
/// ///
/// /// ```rune
/// /// let string = String::empty();
/// /// assert_eq!(string, "hello");
/// /// ```
/// #[rune::function(free, path = String::empty)]
/// fn empty() -> String {
/// String {
/// inner: std::string::String::new()
/// }
/// }
///
/// /// Lowercase the string inside of the string wrapper.
/// ///
/// /// # Examples
/// ///
/// /// ```rune
/// /// let string = String::new("Hello");
/// /// assert_eq!(string.to_lowercase(), "hello");
/// /// ```
/// #[rune::function(instance)]
/// fn to_lowercase(this: &String) -> String {
/// String {
/// inner: this.inner.to_lowercase()
/// }
/// }
///
/// fn module() -> Result<Module, ContextError> {
/// let mut m = Module::new();
/// m.ty::<String>()?;
/// m.function_meta(String::new)?;
/// m.function_meta(empty)?;
/// m.function_meta(String::to_uppercase)?;
/// m.function_meta(to_lowercase)?;
/// m.function_meta(String::display)?;
/// Ok(m)
/// }
/// ```
///
/// # Using `vm_result` and `<expr>.vm?`.
///
/// In order to conveniently deal with virtual machine errors which require use
/// [`VmResult`] this attribute macro supports the `vm_result` option.
///
/// This changes the return value of the function to be [`VmResult`], and
/// ensures that any try operator use is wrapped as appropriate. The special
/// operator `<expr>.vm?` is also supported in this context, which is a
/// shorthand for the [`vm_try!`] macro.
///
/// ```
/// use rune::alloc::String;
/// use rune::alloc::prelude::*;
///
/// #[rune::function(vm_result)]
/// fn trim(string: &str) -> String {
/// string.trim().try_to_owned().vm?
/// }
/// ```
///
/// This can be combined with regular uses of the try operator `?`:
///
/// ```
/// use core::str::Utf8Error;
///
/// use rune::alloc::String;
/// use rune::alloc::prelude::*;
///
/// #[rune::function(vm_result)]
/// fn trim_bytes(bytes: &[u8]) -> Result<String, Utf8Error> {
/// Ok(core::str::from_utf8(bytes)?.trim().try_to_owned().vm?)
/// }
/// ```
///
/// # Using `keep` to keep the name
///
/// By default, the name of the function is mangled and the metadata is given
/// the original name. This means you can't easily call the function from both
/// Rune and Rust. This behaviour can be changed by using the `keep` attribute, in
/// which case you must refer to the meta object by a mangled name
/// (specifically the function name with `__meta` appended):
///
/// ```
/// use rune::{Module, ContextError};
///
/// /// Don't mangle the name of the function
/// #[rune::function(keep)]
/// fn to_uppercase(string: &str) -> String {
/// string.to_uppercase()
/// }
///
/// fn module() -> Result<Module, ContextError> {
/// let mut m = Module::new();
/// m.function_meta(to_uppercase__meta)?;
/// Ok(m)
/// }
///
/// fn call_from_rust() {
/// assert_eq!(to_uppercase("hello"), "HELLO");
/// }
/// ```
///
/// [`VmResult`]: crate::runtime::VmResult
/// [`vm_try!`]: crate::vm_try!
pub use rune_macros::function;
/// Macro used to annotate native functions which can be loaded as macros in
/// rune.
///
/// See [`Module::macro_meta`].
#[doc(hidden)]
pub use rune_macros::macro_;
/// Macro used to annotate native functions which can be loaded as attribute
/// macros in rune.
///
/// See [`Module::macro_meta`].
#[doc(hidden)]
pub use rune_macros::attribute_macro;
/// Macro used to annotate a module with metadata.
///
/// ThIs defines a local function `module_meta` which can be used in conjunction
/// with [`Module::from_meta`] to construct a module with a given item and
/// captured documentation.
#[doc(inline)]
pub use rune_macros::module;
#[doc(inline)]
pub use rune_macros::hash;
pub use rune_macros::item;
#[cfg(feature = "cli")]
mod ace;
#[cfg(feature = "cli")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "cli")))]
pub mod cli;
#[cfg(feature = "languageserver")]
pub mod languageserver;
#[cfg(feature = "doc")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "doc")))]
pub(crate) mod doc;
/// Privately exported details.
#[doc(hidden)]
pub mod __private {
pub use crate::any::AnyMarker;
pub use crate::function_meta::{
FunctionMetaData, FunctionMetaKind, FunctionMetaStatics, MacroMetaData, MacroMetaKind,
};
pub use crate::item::ItemBuf;
pub use crate::module::{InstallWith, Module, ModuleMetaData};
pub use crate::params::Params;
pub use crate::runtime::{TypeHash, TypeOf};
pub use rust_alloc::boxed::Box;
pub use rust_alloc::sync::Arc;
}
mod musli;
mod serde;
#[cfg(test)]
mod tests;
rune_macros::binding! {
impl ::std::string::String for crate::alloc::String;
#[cfg(feature = "std")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "std")))]
impl ::std::io::Error for std::io::Error;
#[cfg(feature = "alloc")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "alloc")))]
impl ::std::string::FromUtf8Error for crate::alloc::string::FromUtf8Error;
impl ::std::error::Error for anyhow::Error;
impl ::std::fmt::Error for core::fmt::Error;
impl ::std::char::ParseCharError for core::char::ParseCharError;
impl ::std::num::ParseFloatError for core::num::ParseFloatError;
impl ::std::num::ParseIntError for core::num::ParseIntError;
impl ::std::string::Utf8Error for core::str::Utf8Error;
#[any]
impl ::std::option::Option for Option<Value>;
#[type_of]
impl<T> ::std::option::Option for Option<T>;
#[any]
impl ::std::result::Result for Result<Value, Value>;
#[type_of]
impl<T, E> ::std::result::Result for Result<T, E>;
#[type_of]
impl ::std::bool for bool;
#[type_of]
impl ::std::char for char;
#[type_of]
impl ::std::i64 for i8;
#[type_of]
impl ::std::i64 for i16;
#[type_of]
impl ::std::i64 for i32;
#[type_of]
impl ::std::i64 for i64;
#[type_of]
impl ::std::i64 for i128;
#[type_of]
impl ::std::i64 for isize;
#[type_of]
impl ::std::u64 for u8;
#[type_of]
impl ::std::u64 for u16;
#[type_of]
impl ::std::u64 for u32;
#[type_of]
impl ::std::u64 for u64;
#[type_of]
impl ::std::u64 for u128;
#[type_of]
impl ::std::u64 for usize;
#[type_of]
impl ::std::f64 for f32;
#[type_of]
impl ::std::f64 for f64;
#[type_of]
impl<C, B> ::std::ops::ControlFlow for core::ops::ControlFlow<C, B>;
#[type_of]
impl ::std::bytes::Bytes for [u8];
#[type_of]
impl ::std::cmp::Ordering for core::cmp::Ordering;
#[type_of]
#[cfg(feature = "alloc")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "alloc")))]
#[type_of]
impl ::std::string::String for ::rust_alloc::string::String;
#[type_of]
impl ::std::string::String for crate::alloc::Box<str>;
#[type_of]
impl ::std::string::String for str;
#[type_of]
impl ::std::vec::Vec for [Value];
#[type_of]
#[cfg(feature = "alloc")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "alloc")))]
#[type_of]
impl<T> ::std::vec::Vec for ::rust_alloc::vec::Vec<T>;
#[type_of]
impl<T> ::std::vec::Vec for crate::alloc::Vec<T>;
#[type_of]
impl<T> ::std::vec::Vec for crate::runtime::VecTuple<T>;
#[type_of]
impl ::std::tuple::Tuple for crate::runtime::Tuple;
#[type_of]
impl<T> ::std::object::Object for crate::alloc::HashMap<::rust_alloc::string::String, T>;
#[type_of]
impl<T> ::std::object::Object for crate::alloc::HashMap<alloc::String, T>;
#[type_of]
#[cfg(feature = "std")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "std")))]
impl<T> ::std::object::Object for std::collections::HashMap<::rust_alloc::string::String, T>;
#[type_of]
#[cfg(feature = "std")]
#[cfg_attr(rune_docsrs, doc(cfg(feature = "std")))]
impl<T> ::std::object::Object for std::collections::HashMap<alloc::String, T>;
#[type_of]
impl ::std::any::Type for crate::runtime::Type;
}