pedant-types 0.15.0

Shared types for pedant capability analysis
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

//! Dense report identifiers branded by the collection they index.

use std::marker::PhantomData;

use serde::{Deserialize, Serialize};

/// One dense `u32` index whose marker fixes the collection it addresses.
#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
#[serde(transparent)]
pub struct Id<K> {
    index: u32,
    #[serde(skip)]
    kind: PhantomData<fn() -> K>,
}

impl<K> Id<K> {
    /// The identifier's position in its report slice.
    pub fn index(self) -> u32 {
        self.index
    }

    pub(crate) fn new(index: u32) -> Self {
        Self {
            index,
            kind: PhantomData,
        }
    }
}

/// Marker distinguishing unit identifiers from the other ID kinds.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct UnitIdKind;

/// Marker distinguishing definition identifiers from the other ID kinds.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct DefinitionIdKind;

/// Marker distinguishing reference identifiers from the other ID kinds.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ReferenceIdKind;

/// A resolution unit's dense identifier within one report.
pub type ResolutionUnitId = Id<UnitIdKind>;

/// A definition's dense identifier within one report.
pub type DefinitionId = Id<DefinitionIdKind>;

/// A reference's dense identifier within one report.
pub type ReferenceId = Id<ReferenceIdKind>;