stac-io 0.2.8

Input and output (I/O) for the SpatioTemporal Asset Catalog (STAC)
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

pub mod api;
mod error;
mod format;
#[cfg(feature = "geoparquet")]
mod geoparquet;
mod json;
mod ndjson;
mod read;
mod realized_href;
#[cfg(feature = "store")]
pub mod store;
mod write;

#[cfg(feature = "geoparquet")]
pub use geoparquet::{FromGeoparquetPath, IntoGeoparquetPath};
#[cfg(feature = "store")]
pub use store::{StacStore, parse_href, parse_href_opts};
pub use {
    error::Error,
    format::Format,
    json::{FromJsonPath, ToJsonPath},
    ndjson::{FromNdjsonPath, ToNdjsonPath, ndjson_item_reader},
    read::read,
    realized_href::RealizedHref,
    write::write,
};

/// Crate-specific result type.
pub type Result<T> = std::result::Result<T, Error>;

/// Composite trait for all formats readable by stac-io.
#[cfg(feature = "geoparquet")]
pub trait Readable: FromJsonPath + FromNdjsonPath + FromGeoparquetPath {}
#[cfg(not(feature = "geoparquet"))]
pub trait Readable: FromJsonPath + FromNdjsonPath {}

#[cfg(feature = "geoparquet")]
impl<T> Readable for T where T: FromJsonPath + FromNdjsonPath + FromGeoparquetPath {}
#[cfg(not(feature = "geoparquet"))]
impl<T> Readable for T where T: FromJsonPath + FromNdjsonPath {}

/// Composite trait for all formats writeable by stac-io.
#[cfg(feature = "geoparquet")]
pub trait Writeable: ToJsonPath + ToNdjsonPath + IntoGeoparquetPath {}
#[cfg(not(feature = "geoparquet"))]
pub trait Writeable: ToJsonPath + ToNdjsonPath {}

#[cfg(feature = "geoparquet")]
impl<T> Writeable for T where T: ToJsonPath + ToNdjsonPath + IntoGeoparquetPath {}
#[cfg(not(feature = "geoparquet"))]
impl<T> Writeable for T where T: ToJsonPath + ToNdjsonPath {}

/// Returns a string suitable for use as a HTTP user agent.
pub fn user_agent() -> &'static str {
    concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"))
}

#[cfg(test)]
mod tests {
    use stac::{Catalog, Collection, Item, ItemCollection};
    use tempfile::TempDir;

    macro_rules! read {
        ($function:ident, $filename:expr_2021, $value:ty $(, $meta:meta)?) => {
            #[test]
            $(#[$meta])?
            fn $function() {
                use stac::SelfHref;

                let value: $value = crate::read($filename).unwrap();
                assert!(value.self_href().is_some());
            }
        };
    }

    read!(read_item_from_path, "examples/simple-item.json", Item);
    read!(read_catalog_from_path, "examples/catalog.json", Catalog);
    read!(
        read_collection_from_path,
        "examples/collection.json",
        Collection
    );
    read!(
        read_item_collection_from_path,
        "data/item-collection.json",
        ItemCollection
    );

    mod read_with_reqwest {
        use stac::{Catalog, Collection, Item};

        read!(
            read_item_from_url,
            "https://raw.githubusercontent.com/radiantearth/stac-spec/master/examples/simple-item.json",
            Item
        );
        read!(
            read_catalog_from_url,
            "https://raw.githubusercontent.com/radiantearth/stac-spec/master/examples/catalog.json",
            Catalog
        );
        read!(
            read_collection_from_url,
            "https://raw.githubusercontent.com/radiantearth/stac-spec/master/examples/collection.json",
            Collection
        );
    }

    #[test]
    #[cfg(feature = "geoparquet")]
    fn read_geoparquet() {
        let _: ItemCollection = super::read("data/extended-item.parquet").unwrap();
    }

    #[test]
    #[cfg(not(feature = "geoparquet"))]
    fn read_geoparquet_without_geoparquet() {
        let _ = super::read::<ItemCollection>("data/extended-item.parquet").unwrap_err();
    }

    #[test]
    fn write() {
        let tempdir = TempDir::new().unwrap();
        let item = Item::new("an-id");
        super::write(tempdir.path().join("item.json"), item).unwrap();
        let item: Item = super::read(tempdir.path().join("item.json").to_string_lossy()).unwrap();
        assert_eq!(item.id, "an-id");
    }
}