platform-data 2.0.0

Data types and traits for the LinksPlatform
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use std::ops::RangeInclusive;

use crate::Hybrid;
use platform_num::LinkReference;

#[derive(Clone, Eq, PartialEq, Debug)]
pub struct LinksConstants<T: LinkReference> {
    pub index_part: T,
    pub source_part: T,
    pub target_part: T,
    pub null: T,
    pub r#continue: T,
    pub r#break: T,
    pub skip: T,
    pub any: T,
    pub itself: T,
    pub error: T,
    pub internal_range: RangeInclusive<T>,
    pub external_range: Option<RangeInclusive<T>>,
}

impl<T: LinkReference> LinksConstants<T> {
    fn default_target_part() -> T {
        T::from_byte(2)
    }

    pub fn full_new(
        target_part: T,
        internal: RangeInclusive<T>,
        external: Option<RangeInclusive<T>>,
    ) -> Self {
        Self {
            index_part: T::from_byte(0),
            source_part: T::from_byte(1),
            target_part,
            null: T::from_byte(0),
            r#continue: *internal.end(),
            r#break: *internal.end() - T::from_byte(1),
            skip: *internal.end() - T::from_byte(2),
            any: *internal.end() - T::from_byte(3),
            itself: *internal.end() - T::from_byte(4),
            error: *internal.end() - T::from_byte(5),
            internal_range: *internal.start()..=*internal.end() - T::from_byte(6),
            external_range: external,
        }
    }

    // TODO: enough for now
    pub fn via_external(target_part: T, external: bool) -> Self {
        Self::full_new(
            target_part,
            Self::default_internal(external),
            Self::default_external(external),
        )
    }

    pub fn via_ranges(internal: RangeInclusive<T>, external: Option<RangeInclusive<T>>) -> Self {
        Self::full_new(Self::default_target_part(), internal, external)
    }

    #[must_use]
    pub fn via_only_external(external: bool) -> Self {
        Self::via_external(Self::default_target_part(), external)
    }

    #[must_use]
    pub fn external() -> Self {
        Self::via_only_external(true)
    }

    #[must_use]
    pub fn internal() -> Self {
        Self::via_only_external(false)
    }

    #[must_use]
    pub fn new() -> Self {
        Self::internal()
    }

    fn default_internal(external: bool) -> RangeInclusive<T> {
        if external {
            T::from_byte(1)..=Hybrid::half()
        } else {
            T::from_byte(1)..=T::MAX
        }
    }

    fn default_external(external: bool) -> Option<RangeInclusive<T>> {
        if external {
            Some(Hybrid::half()..=T::MAX)
        } else {
            None
        }
    }

    pub fn is_internal(&self, address: T) -> bool {
        self.internal_range.contains(&address)
    }

    pub fn is_external(&self, address: T) -> bool {
        self.external_range
            .clone()
            .is_some_and(|range| range.contains(&address))
    }

    pub fn is_reference(&self, address: T) -> bool {
        self.is_internal(address) || self.is_external(address)
    }
}

impl<T: LinkReference> Default for LinksConstants<T> {
    fn default() -> Self {
        Self::new()
    }
}