unitscale 0.1.0

Facade crate for statically-scaled unit macros and traits.
Documentation 
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

// Copyright 2025 GooseGrid Technologies
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! # unitscale
//!
//! ## Overview
//!
//! This is the public-facing facade crate that re-exports the traits and macros from unitscale_core and unitscale_macros. It is designed to be ergonomic and beginner-friendly.
//!
//! ## Modules
//!
//! * core: Exposes all traits and types from unitscale_core.
//! * macros: Exposes macros from unitscale_macros.
//! * prelude: Contains common re-exports for quick onboarding.
//!
//! ## Example
//!
//! ```rust
//! use unitscale::prelude::*;
//!
//! #[unit_scale(to = 0.5)]
//! pub struct HalfUnit;
//!
//! #[unit_data]
//! pub struct Percent;
//!
//! let p = Percent::<HalfUnit, u8>::try_from(30.0).unwrap();
//! assert_eq!(p.value(), 60);
//! ```
//!
//! ## Use Cases
//!
//! This crate is ideal for anyone working with embedded systems, battery management protocols, or anywhere you need strongly typed unit data tied to fixed encoding scales.
//!
//! ## Licensing
//!
//! For licensing information, please refer to the LICENSE file in each crate.

/// Core traits and types (e.g., `UnitScale`, `Scaled`)
pub mod core {
    pub use unitscale_core::*;
}

/// Procedural macros (`unit_data`, `unit_scale`)
pub mod macros {
    pub use unitscale_macros::*;
}

/// Common imports for users
pub mod prelude {
    pub use crate::core::{Scaled, UnitScale, UnitScaleError};
    pub use crate::macros::{unit_data, unit_scale};
}