11 releases
0.5.6 | Mar 18, 2023 |
---|---|
0.5.3 | Sep 14, 2022 |
0.5.2 | Apr 1, 2022 |
0.5.1 | Jan 1, 2022 |
0.2.0 | Jun 4, 2020 |
#1084 in Procedural macros
388 downloads per month
Used in 2 crates
(via bounded-integer)
74KB
1.5K
SLoC
Bounded Integer
This crate provides two types of bounded integer for use in Rust.
Macro-generated bounded integers
The bounded_integer!
macro allows you to define your own bounded integer type, given a
specific range it inhabits. For example:
bounded_integer! {
struct MyInteger { 0..8 }
}
let num = MyInteger::new(5).unwrap();
assert_eq!(num, 5);
This macro supports both struct
s and enum
s. See the examples
module for the
documentation of generated types.
Const generics-based bounded integers
You can also create ad-hoc bounded integers via types in this library that use const generics, for example:
let num = <BoundedU8<0, 7>>::new(5).unwrap();
assert_eq!(num, 5);
These integers are shorter to use as they don't require a type declaration or explicit name,
and they interoperate better with other integers that have different ranges. However due to the
limits of const generics, they do not implement some traits like Default
.
no_std
All the integers in this crate depend only on libcore and so work in #![no_std]
environments.
Crate Features
By default, no crate features are enabled.
std
: Interopate withstd
— impliesalloc
. Enables the following things:- An implementation of
Error
forParseError
.
- An implementation of
alloc
: Interopate withalloc
. Enables the following things:- Support for indexing with the const-generic integers on
Vec
andVecDeque
.
- Support for indexing with the const-generic integers on
macro
: Enable thebounded_integer!
macro.types
: Enable the bounded integer types that use const generics.arbitrary1
: ImplementArbitrary
for the bounded integers. This is useful when using bounded integers as fuzzing inputs.bytemuck1
: ImplementContiguous
for all bounded integers, andZeroable
for macro-generated bounded integers that support it.num-traits02
: ImplementBounded
,AsPrimitive
,FromPrimitive
,NumCast
,ToPrimitive
,CheckedAdd
,CheckedDiv
,CheckedMul
,CheckedNeg
,CheckedRem
,CheckedSub
,MulAdd
,SaturatingAdd
,SaturatingMul
andSaturatingSub
for all const-generic bounded integers.serde1
: ImplementSerialize
andDeserialize
for the bounded integers, making sure all values will never be out of bounds. This has a deprecated aliasserde
.zerocopy06
: ImplementAsBytes
for all bounded integers, andUnaligned
for macro-generated ones.step_trait
: Implement theStep
trait which allows the bounded integers to be easily used in ranges. This will require you to use nightly and place#![feature(step_trait)]
in your crate root if you use the macro.
License
Copyright © 2016, Curtis McEnroe curtis@cmcenroe.me
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Dependencies
~0.6–1.2MB
~27K SLoC