excel-api 0.1.0

Safe Rust abstractions for native Microsoft Excel XLL add-ins
Documentation
  • Coverage
  • 100%
    656 out of 656 items documented13 out of 230 items with examples
  • Size
  • Source code size: 541.8 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 9.2 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 7s Average build duration of successful builds.
  • all releases: 7s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • evnekdev/excel-api
    2 1 51
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • evnekdev

excel-api

Safe Rust building blocks for native 64-bit Microsoft Excel XLL add-ins.

excel-api is the high-level companion to excel-api-sys: callback inputs are borrowed for exactly their Excel callback lifetime, owned semantic values are pointer-free, return planning allocates stable DLL-owned XLOPER12 storage, and typed contexts restrict Excel calls to documented callback capabilities.

Quick start

use excel_api::prelude::*;

#[cfg(feature = "macros")]
#[excel_function(
    name = "RUST.ADD", thunk = "rust_add",
    arguments(left = "First addend.", right = "Second addend.")
)]
fn add(left: f64, right: f64) -> f64 { left + right }

# fn main() {}

The default macros feature re-exports excel_function and excel_command. xlcontime-research is an experimental, doc-hidden compatibility probe; it is not a supported autonomous wake mechanism. RTD, COM/Ribbon UI, task panes, and autonomous notification are outside the stable core.

Async UDFs and the cooperative dispatcher are preview features: automated coverage is present, while their full Excel lifecycle/pump validation remains pending. Enqueueing dispatcher work never wakes Excel.

See the repository user guide, the minimal XLL example, and the crate Rustdoc for API-specific ownership and callback restrictions.

Supported target: 64-bit Windows Excel using the Excel 12 C API. 32-bit Excel and arbitrary background-thread Excel calls are unsupported.

Licensed under either Apache-2.0 or MIT.