moniker 0.5.0

Automatically derive variable binding and alpha equivalence for abstract syntax trees
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

use std::fmt;
use std::hash::{Hash, Hasher};

use unique_id::UniqueId;

/// A free variable
#[derive(Debug, Clone)]
pub struct FreeVar<N> {
    /// A generated id
    pub unique_id: UniqueId,
    /// programmer-provided name for pretty-printing
    pub pretty_name: Option<N>,
}

impl<N> FreeVar<N> {
    /// Create a fresh free variable, with an optional name hint for pretty printing
    pub fn fresh(pretty_name: Option<N>) -> FreeVar<N> {
        FreeVar {
            unique_id: UniqueId::new(),
            pretty_name,
        }
    }

    /// Create a fresh free variable, with no name hint
    pub fn fresh_unnamed() -> FreeVar<N> {
        FreeVar::fresh(None)
    }

    /// Create a fresh free variable, with a name hint for pretty printing
    pub fn fresh_named(pretty_name: impl Into<N>) -> FreeVar<N> {
        FreeVar::fresh(Some(pretty_name.into()))
    }
}

impl<N> PartialEq for FreeVar<N>
where
    N: PartialEq,
{
    fn eq(&self, other: &FreeVar<N>) -> bool {
        self.unique_id == other.unique_id
    }
}

impl<N> Eq for FreeVar<N> where N: Eq {}

impl<N> Hash for FreeVar<N>
where
    N: Hash,
{
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.unique_id.hash(state);
    }
}

impl<N: fmt::Display> fmt::Display for FreeVar<N> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self.pretty_name {
            None => write!(f, "${}", self.unique_id),
            Some(ref pretty_name) => write!(f, "{}${}", pretty_name, self.unique_id),
        }
    }
}