Skip to main content

atliac_crate_template/
lib.rs

1//! # atliac-crate-template
2//!
3//! A minimal, production-ready Rust template designed to jumpstart library (crate) development.
4//! It establishes a workspace-friendly structure and comes pre-configured with automated release
5//! pipelines, versioning, and cross-platform distribution.
6//!
7//! ## Example
8//!
9//! ```rust
10//! use atliac_crate_template::add;
11//!
12//! assert_eq!(add(2, 3), 5);
13//! ```
14
15/// Adds two numbers.
16///
17/// This is a placeholder function to demonstrate the library structure.
18///
19/// # Examples
20///
21/// ```rust
22/// use atliac_crate_template::add;
23///
24/// let result = add(2, 2);
25/// assert_eq!(result, 4);
26/// ```
27pub fn add(left: u64, right: u64) -> u64 {
28    left + right
29}
30
31#[cfg(test)]
32mod tests {
33    use super::*;
34
35    #[test]
36    fn add_works() {
37        let result = add(2, 2);
38        assert_eq!(result, 4);
39    }
40}