routers 0.2.3

Rust-Based Routing Tooling for System-Agnostic Maps.
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

use petgraph::graph::NodeIndex;

/// The identifier for candidates within the source
/// candidate graph, [`Candidates`].
pub type CandidateId = NodeIndex;

#[derive(Copy, Clone)]
pub struct CandidateRef {
    /// Emission cost of the candidate
    weight: Option<u32>,
}

impl CandidateRef {
    /// Indicates a candidate which exists for routing purposes,
    /// and can only be reached in a resolution step.
    ///
    /// This cannot be called on user-end.
    pub(crate) fn butt() -> Self {
        Self { weight: None }
    }

    /// Creates a standard candidate reference, which contains the
    /// nodes weighting (Derived from the Emission cost).
    pub fn new(weight: u32) -> Self {
        Self {
            weight: Some(weight),
        }
    }

    /// Determines if the candidate was created using [`CandidateId::butt`]
    pub(crate) fn is_butt(&self) -> bool {
        self.weight.is_none()
    }

    pub fn weight(&self) -> u32 {
        self.weight.unwrap_or_default()
    }
}