ironcalc/lib.rs
1//! # IronCalc - Core API documentation
2//!
3//! This technical API documentation is aimed at developers.
4//! It is used to build language bindings (like python, javascript or nodejs) or to build full fledged applications like TironCalc in the terminal or IronCalc, the Web application.
5//!
6//! ## Basic usage
7//!
8//! Add the dependency in `Cargo.toml`:
9//!
10//! ```toml
11//! [dependencies]
12//! ironcalc = { git = "https://github.com/ironcalc/IronCalc", tag = "v0.8.3" }
13//! ```
14//!
15//! A simple example with some numbers, a new sheet and a formula:
16//!
17//!
18//! ```rust,no_run
19#![doc = include_str!("../examples/hello_calc.rs")]
20//! ```
21//!
22//! ## Examples
23//!
24//! This is a collection of full fledged examples you can use as a starting point or for learning purposes.
25//! You might find the code in the examples folder
26//!
27//! ### Styling the workbook
28//!
29//! Adding colors, to cells, full columns or full rows is easy
30//!
31//! ```rust,no_run
32#![doc = include_str!("../examples/hello_styles.rs")]
33//! ```
34//!
35//! ### Changing column width and row heigh
36//!
37//! ```rust,no_run
38#![doc = include_str!("../examples/widths_and_heights.rs")]
39//! ```
40
41#![doc(
42 html_logo_url = "https://raw.githubusercontent.com/ironcalc/ironcalc/main/assets/logo.png",
43 html_favicon_url = "https://raw.githubusercontent.com/ironcalc/ironcalc/main/assets/favicon.ico"
44)]
45
46pub mod compare;
47pub mod error;
48pub mod export;
49pub mod import;
50pub mod util;
51pub use ironcalc_base as base;
52
53#[cfg(feature = "mock_time")]
54pub mod mock_time;