Struct RangeCfg 

pub struct RangeCfg<T: Copy + PartialOrd> { /* private fields */ }

Configuration for limiting the range of a value.

This is often used to configure length limits for variable-length types or collections.

Examples

use commonware_codec::RangeCfg;

// Limit lengths to 0..=1024 (type inferred as usize)
let cfg = RangeCfg::new(0..=1024);
assert!(cfg.contains(&500));
assert!(!cfg.contains(&2000));

// Allow any length >= 1
let cfg_min = RangeCfg::from(1..);
assert!(cfg_min.contains(&1));
assert!(!cfg_min.contains(&0));

// Works with other integer types
let cfg_u8: RangeCfg<u8> = RangeCfg::new(0u8..=255u8);
assert!(cfg_u8.contains(&128));

let cfg_u32 = RangeCfg::new(0u32..1024u32);
assert!(cfg_u32.contains(&500));

Implementations

impl<T: Copy + PartialOrd> RangeCfg<T>

pub fn new(r: impl RangeBounds<T>) -> Self

Creates a new RangeCfg from any type implementing RangeBounds<T>.

Examples

use commonware_codec::RangeCfg;

let cfg = RangeCfg::new(0..=1024);
assert!(cfg.contains(&500));

pub fn exact(value: T) -> Self

Creates a RangeCfg that only accepts exactly value.

pub fn contains(&self, value: &T) -> bool

Returns true if the value is within this range.

Trait Implementations

impl<T: Clone + Copy + PartialOrd> Clone for RangeCfg<T>

fn clone(&self) -> RangeCfg<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Copy + PartialOrd> Debug for RangeCfg<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Copy + PartialOrd> From<Range<T>> for RangeCfg<T>

fn from(r: Range<T>) -> Self

Converts to this type from the input type.

impl<T: Copy + PartialOrd> From<RangeFrom<T>> for RangeCfg<T>

fn from(r: RangeFrom<T>) -> Self

Converts to this type from the input type.

impl<T: Copy + PartialOrd> From<RangeFull> for RangeCfg<T>

fn from(_: RangeFull) -> Self

Converts to this type from the input type.

impl<T: Copy + PartialOrd> From<RangeInclusive<T>> for RangeCfg<T>

fn from(r: RangeInclusive<T>) -> Self

Converts to this type from the input type.

impl<T: Copy + PartialOrd> From<RangeTo<T>> for RangeCfg<T>

fn from(r: RangeTo<T>) -> Self

Converts to this type from the input type.

impl<T: Copy + PartialOrd> From<RangeToInclusive<T>> for RangeCfg<T>

fn from(r: RangeToInclusive<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + Copy + PartialOrd> Hash for RangeCfg<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq + Copy + PartialOrd> PartialEq for RangeCfg<T>

fn eq(&self, other: &RangeCfg<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy + PartialOrd> RangeBounds<T> for RangeCfg<T>

fn start_bound(&self) -> Bound<&T>

Start index bound.

fn end_bound(&self) -> Bound<&T>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl<T: Copy + Copy + PartialOrd> Copy for RangeCfg<T>

impl<T: Eq + Copy + PartialOrd> Eq for RangeCfg<T>

impl<T: Copy + PartialOrd> StructuralPartialEq for RangeCfg<T>