calm-ops

Non panicing operations made easy.

To avoid panics on integer overflow, Rust provides several functions for integers. These are all named according to their respective semantics on overflow: e.g. wrapping_add, saturating_sub, checked_div. These are however more cumbersome to write and read than the standard operators: + - /. Whilst there are the Wrapping and Saturating wrappers in the standard library, you need to wrap and unwrap your values in order to use them. Some languages, like Zig, provide specific operators like +% and +| for specifying the overflow semantics. and whilst you could implement this in rust using macros, I've opted for something different in this crate.

This crate provides four macros: wrapping, saturating, checked and encapsulating, that allow you to specify the overflow semantics.

wrapping!(127_i8 + 1_i8) == -128_i8

saturating!(127_i8 + 1_i8) == 127_i8

checked!(127_i8 + 1_i8) == None

encapsulating!(127_i8 + 1_i8) == 128_i16

They all take an operation expression and evaluates it using the specified sematic. I personally find this more readable than inventing new operators. This is however done in a shallow manner. Therefore,

wrapping!((127_i8 + 1_i8) + 1_i8) != -127_i8

Will still panic.

Casting is also supported.

wrapping!(255_u8 as i8) == -1_i8

saturating!(255_u8 as i8) == 127_i8

checked!(255_u8 as i8) == None