Skip to main content

utz_build/
error.rs

1//! The builder error type follows the workspace error pattern (see
2//! `utz::Error`): the derives come from `derive_more`, foreign errors
3//! enter via `derive_more::From`, and domain variants are
4//! `#[from(skip)]`. Library paths
5//! use typed variants; the measurement tools in `utz_dev_cli` may use
6//! [`Error::Msg`] for one-off messages.
7
8use std::path::PathBuf;
9
10pub type Result<T> = std::result::Result<T, Error>;
11
12/// Anything that can fail while fetching sources or generating an asset.
13#[derive(Debug, derive_more::Display, derive_more::Error, derive_more::From)]
14pub enum Error {
15    /// File or network I/O.
16    Io(std::io::Error),
17    /// A downloaded source archive would not unzip.
18    Zip(zip::result::ZipError),
19    /// Source `GeoJSON` would not parse.
20    Json(serde_json::Error),
21    /// An HTTP failure. The error is boxed because `ureq::Error` is
22    /// large.
23    Http(Box<ureq::Error>),
24    Tiff(tiff::TiffError),
25    Encode(utz_encode::Error),
26    #[cfg(feature = "utz-error")]
27    Utz(utz::Error),
28    #[from(skip)]
29    #[display("unknown dataset {ds:?}: use [land-]now|1970|all")]
30    UnknownDataset {
31        ds: String,
32    },
33    #[from(skip)]
34    #[display("no /releases/tag/ redirect (status {status})")]
35    NoReleaseRedirect {
36        status: u16,
37    },
38    #[from(skip)]
39    #[display("no geojson entry in {}", path.display())]
40    NoGeojsonEntry {
41        path: PathBuf,
42    },
43    #[from(skip)]
44    #[display("no filename in url {url}")]
45    NoFilename {
46        url: String,
47    },
48    #[from(skip)]
49    #[display("no .tif in {}", zip.display())]
50    NoTif {
51        zip: PathBuf,
52    },
53    #[from(skip)]
54    #[display("missing geotransform")]
55    MissingGeotransform,
56    #[from(skip)]
57    #[display("unexpected GHS-POP sample format {format}")]
58    BadSampleFormat {
59        format: String,
60    },
61    #[from(skip)]
62    #[display("bad density sidecar: {_0}")]
63    BadSidecar(#[error(not(source))] &'static str),
64    #[from(skip)]
65    #[display("no OUT_DIR (not in a build.rs?) — set .out_path()")]
66    NoOutDir,
67    /// A one-off message from the `utz_dev_cli` measurement tools.
68    #[from(skip)]
69    #[display("{_0}")]
70    Msg(#[error(not(source))] String),
71}
72
73impl From<ureq::Error> for Error {
74    fn from(error: ureq::Error) -> Self {
75        Error::Http(Box::new(error))
76    }
77}
78
79/// An anyhow-style guard that returns a typed [`Error`].
80#[macro_export]
81macro_rules! ensure {
82    ($cond:expr_2021, $err:expr_2021) => {
83        if !($cond) {
84            return Err($err.into());
85        }
86    };
87}