Crate tor_units

tor-units

Safe wrappers for primitive numeric types.

Overview

This crate is part of Arti, a project to implement Tor in Rust. It provides safe wrappers for primitive numeric wrappers used in other parts of Arti. In particular, it provides:

• a bounded i32 with both checked and clamping constructors,
• an integer milliseconds wrapper with conversion to Duration
• an integer seconds wrapper with conversion to Duration
• a percentage wrapper, to prevent accidental failure to divide by 100.
• a SendMeVersion which can be compared only.

Compile-time features

• memquota-memcost – implement tor_memquota::HasMemoryCost for many types. (Does not actually force compiling in memory quota tracking; that’s memquota in tor-memquota and higher-level crates.)

• full – Enable all features above.

License: MIT OR Apache-2.0

Structs

• BoundedInt32
  A 32-bit signed integer with a restricted range.
• IntegerDays
  This type represents an integer number of days.
• IntegerMilliseconds
  This type represents an integer number of milliseconds.
• IntegerMinutes
  This type represents an integer number of minutes.
• IntegerSeconds
  This type represents an integer number of seconds.
• Percentage
  A percentage value represented as a number.
• SendMeVersion
  A SendMe Version

Enums

• Error
  Conversion errors from converting a value into a BoundedInt32.