rich_range 0.1.0

Range calculation helper.
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

//! Provider of [`CutMode`].

use crate::shorthands::aliases::*;
use core::ops::Bound;

/// Cut mode.
///
/// This value is used by the [`RichRangeBounds::cut`] method and
/// its family. In the methods, this value specifies how to handle
/// the bound variants of range cut ends.
///
/// [`RichRangeBounds::cut`]: crate::RichRangeBounds::cut
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
pub enum CutMode {
    /// Start bound is Included, End bound is Excluded.
    Standard,

    /// Start bound is Excluded, End bound is Included.
    Backward,

    /// Start and end bound is both Included.
    Included,

    /// Start and end bound is both Excluded.
    Excluded,
}

impl CutMode {
    /// Returns bound for start side.
    #[must_use]
    pub fn for_start<T>(&self, pos: T) -> Bound<T> {
        match self {
            CutMode::Standard => In(pos),
            CutMode::Backward => Ex(pos),
            CutMode::Included => In(pos),
            CutMode::Excluded => Ex(pos),
        }
    }

    /// Returns bound for end side.
    #[must_use]
    pub fn for_end<T>(&self, pos: T) -> Bound<T> {
        match self {
            CutMode::Standard => Ex(pos),
            CutMode::Backward => In(pos),
            CutMode::Included => In(pos),
            CutMode::Excluded => Ex(pos),
        }
    }
}