fcb_core 0.7.6

FlatCityBuf is a library for reading and writing CityJSON with FlatBuffers. Contains code derived from FlatGeobuf (BSD-2-Clause) for spatial indexing.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

use thiserror::Error;

/// Errors that can occur during CityJSON operations
#[derive(Error, Debug)]
pub enum CjError {
    #[error("IO error during CityJSON operation: {0}")]
    Io(#[from] std::io::Error),

    #[error("Invalid CityJSON: {source}")]
    CityJSON {
        #[from]
        source: serde_json::Error,
    },

    #[error("Missing required field: {field}")]
    MissingField { field: String },

    #[error("Invalid CityJSON version: {version}")]
    InvalidVersion { version: String },

    #[error("Invalid CityObject type: {type_}")]
    InvalidObjectType { type_: String },

    #[error("Invalid geometry: {msg}")]
    InvalidGeometry { msg: String },

    #[error("Invalid semantic surface: {msg}")]
    InvalidSemantics { msg: String },
}

impl CjError {
    /// Creates a new MissingField error
    pub fn missing_field(field: impl Into<String>) -> Self {
        Self::MissingField {
            field: field.into(),
        }
    }

    /// Creates a new InvalidVersion error
    pub fn invalid_version(version: impl Into<String>) -> Self {
        Self::InvalidVersion {
            version: version.into(),
        }
    }

    /// Creates a new InvalidObjectType error
    pub fn invalid_object_type(type_: impl Into<String>) -> Self {
        Self::InvalidObjectType {
            type_: type_.into(),
        }
    }

    /// Creates a new InvalidGeometry error
    pub fn invalid_geometry(msg: impl Into<String>) -> Self {
        Self::InvalidGeometry { msg: msg.into() }
    }

    /// Creates a new InvalidSemantics error
    pub fn invalid_semantics(msg: impl Into<String>) -> Self {
        Self::InvalidSemantics { msg: msg.into() }
    }

    /// Returns true if the error is related to missing or invalid fields
    pub fn is_field_error(&self) -> bool {
        matches!(self, CjError::MissingField { .. })
    }

    /// Returns true if the error is related to CityJSON validation
    pub fn is_validation_error(&self) -> bool {
        matches!(
            self,
            CjError::InvalidVersion { .. }
                | CjError::InvalidObjectType { .. }
                | CjError::InvalidGeometry { .. }
                | CjError::InvalidSemantics { .. }
        )
    }
}