substrate-data 0.1.0

One data model, text syntax, binary form, packed frames and schema system — for any program's files, saves and wire messages.
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

//! [`Resolve`]: what a tool makes of the references it reads, and
//! [`Unresolved`], why one is wrong.

use std::fmt;

use crate::model::value::{Path, Ref, RefKey};

/// What a tool makes of the references it reads: a build checks each one
/// against what there is (and may rewrite its id), an editor shows them.
pub trait Resolve {
    /// A reference at `path`: the id to keep, or why it's wrong.
    ///
    /// # Errors
    ///
    /// [`Unresolved`] when the reference names nothing there is, or names
    /// it in a way the tool refuses.
    fn reference(&mut self, r: &Ref, path: &Path) -> Result<RefKey, Unresolved>;
}

/// Why a reference doesn't resolve.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Unresolved {
    /// There is nothing it names.
    Missing(Ref),
    /// It names something, but not in a way this tool takes (a reason for a person).
    Refused {
        /// The reference.
        reference: Ref,
        /// Why, for a person.
        reason: String,
    },
}

impl fmt::Display for Unresolved {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Unresolved::Missing(r) => write!(f, "`{r}`: there is no such {}", r.kind),
            Unresolved::Refused { reference, reason } => write!(f, "`{reference}`: {reason}"),
        }
    }
}

impl std::error::Error for Unresolved {}