ifc-model 0.3.0

The IFC entity graph: storage and structural queries, free of domain semantics and serialization.
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

//! Why a model operation failed.

use crate::value::EntityId;
use thiserror::Error;

/// Errors from reading, writing, or querying a model.
///
/// Codec-specific detail is carried as a message rather than a nested error
/// type: this crate must not depend on any codec, so it cannot name their
/// error types.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ModelError {
    /// Underlying I/O failure.
    #[error("io error: {0}")]
    Io(String),

    /// The bytes are not this format at all.
    #[error("not a {expected} file: {detail}")]
    WrongFormat {
        /// Format the codec expected.
        expected: &'static str,
        /// What was seen instead.
        detail: String,
    },

    /// Syntax error at a known location.
    #[error("syntax error at byte {offset}: {detail}")]
    Syntax {
        /// Byte offset into the source.
        offset: usize,
        /// What went wrong.
        detail: String,
    },

    /// An entity referenced an id that does not exist.
    #[error("entity {from} references missing entity {to}")]
    DanglingReference {
        /// The referring entity.
        from: EntityId,
        /// The missing target.
        to: EntityId,
    },

    /// The same id was defined twice.
    #[error("duplicate entity id {0}")]
    DuplicateId(EntityId),

    /// Serialization failed.
    #[error("write error: {0}")]
    Write(String),
}

/// Convenience alias.
pub type ModelResult<T> = Result<T, ModelError>;