Skip to main content

ironcalc_base/
lib.rs

1//! # IronCalcBase engine API
2//!
3//! This is the documentation for the base engine API.
4//!
5//! # Basic usage
6//!
7//! Add the dependency in Cargo.toml:
8//!
9//! ```toml
10//! [dependencies]
11//! ironcalc_base = { git = "https://github.com/ironcalc/IronCalc" }
12//! ```
13//!
14//! <small> until version 1.0.0 you should use the git dependencies as stated </small>
15//!
16//! In this example we use the excel function `CONCAT` to concatenate strings in cells `A1` and `B1`:
17//!
18//! ```rust
19#![doc = include_str!("../examples/hello_world.rs")]
20//! ```
21//!
22//! In this example, we demonstrate our ability to handle formulas and errors:
23//!
24//! ```rust
25#![doc = include_str!("../examples/formulas_and_errors.rs")]
26//! ```
27
28#![warn(clippy::print_stdout)]
29
30pub mod builtin_styles;
31pub mod calc_result;
32pub mod cell;
33pub mod cf_types;
34pub mod colors;
35pub mod expressions;
36pub mod formatter;
37pub mod language;
38pub mod locale;
39pub mod new_empty;
40pub mod number_format;
41pub mod sheet_data;
42pub mod themes;
43pub mod types;
44pub mod worksheet;
45
46pub use crate::constants::COLUMN_WIDTH_FACTOR;
47pub use crate::constants::ROW_HEIGHT_FACTOR;
48
49mod actions;
50mod arithmetic;
51mod cast;
52mod conditional_formatting;
53mod constants;
54mod cut_paste;
55mod evaluation;
56mod functions;
57mod implicit_intersection;
58pub mod links;
59mod merged_cells;
60mod model;
61mod styles;
62mod tz;
63mod units;
64mod user_model;
65mod utils;
66mod workbook;
67
68#[cfg(test)]
69mod test;
70
71#[cfg(any(test, feature = "mock_time"))]
72pub mod mock_time;
73
74pub use locale::get_supported_locales;
75pub use merged_cells::MergeStructure;
76pub use model::get_milliseconds_since_epoch;
77pub use model::FmtSettings;
78pub use model::Model;
79pub use user_model::BorderArea;
80pub use user_model::ClipboardData;
81pub use user_model::UserModel;
82pub use utils::get_all_timezones;