prefixmap 0.2.9

RDF data shapes implementation in Rust
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 crate::PrefixMap;
use iri_s::error::IriSError;
use thiserror::Error;

/// Errors that can occur when working with [`PrefixMap`]
#[derive(Debug, Error, Clone)]
pub enum PrefixMapError {
    /// Error originating from the [`iri_s`] crate
    #[error(transparent)]
    IriSError(#[from] IriSError),

    /// Error indicating that a requested prefix alias was not found in the [`PrefixMap`]
    #[error("Alias '{prefix}' not found in prefix map\nAvailable aliases: [{}]", prefixmap.aliases().cloned().collect::<Vec<_>>().join(", "))]
    PrefixNotFound { prefix: String, prefixmap: PrefixMap },

    /// Error indicating a formatting issue
    #[error(transparent)]
    FormatError(#[from] std::fmt::Error),

    /// Error indicating an IO issue
    #[error("IO Error: {error}")]
    IOError { error: String },

    /// Error indicating that an alias already exists in the [`PrefixMap`]
    #[error("Alias '{prefix}' already exists in prefix map with value '{value}'")]
    AliasAlreadyExists { prefix: String, value: String },
}

/// Error returned when trying to get an IRI from a prefixed name [`IriRef`]
#[derive(Debug, Error, Clone)]
#[error("Cannot obtain IRI from prefixed name IriRef {prefix}:{local}")]
pub struct IriRefError {
    pub prefix: String,
    pub local: String,
}

/// Represents all the possible errors that can occur when dereferencing IRIs
#[derive(Debug, Error, Clone)]
pub enum DerefError {
    /// An error originating from the [`iri_s`] crate
    #[error(transparent)]
    IriSError(#[from] IriSError),

    /// An error originating when obtaining an IRI from a [`PrefixMap`]
    ///
    /// ## Fields
    /// - `error`: The underlying [`PrefixMapError`]
    #[error("Error obtaining IRI for '{alias}:{local}': {error}")]
    DerefPrefixMapError {
        alias: String,
        local: String,
        error: Box<PrefixMapError>,
    },

    /// An error occured when trying to dereference a prefixed name without a prefix map
    #[error("No prefix map to dereference prefixed name {prefix}{local}")]
    NoPrefixMapPrefixedName { prefix: String, local: String },

    /// An error occured when trying to obtain an IRI from an [`IriRef`]
    #[error(transparent)]
    UnderefError(#[from] IriRefError),
}