Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make io::read_json pub(crate) #301

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Make io::read_json pub(crate) #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions stac/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Use `DateTime<Utc>` instead of `String` for datetimes ([#297](https://github.com/stac-utils/stac-rs/pull/297))
- Add `Href.clear_href` ([#299](https://github.com/stac-utils/stac-rs/pull/299))

### Removed

- `stac::read_json` from the public API ([#301](https://github.com/stac-utils/stac-rs/pull/301))

## [0.8.0] - 2024-08-12

### Added
Expand Down
9 changes: 1 addition & 8 deletions stac/src/io.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,7 @@ pub fn read<T: Href + DeserializeOwned>(href: impl ToString) -> Result<T> {
Ok(value)
}

/// Reads any deserializable value from the JSON at an href.
///
/// # Examples
///
/// ```
/// let value: stac::Item = stac::read_json("data/simple-item.json").unwrap();
/// ```
pub fn read_json<T>(href: &str) -> Result<T>
pub(crate) fn read_json<T>(href: &str) -> Result<T>
where
T: DeserializeOwned,
{
Expand Down
2 changes: 1 addition & 1 deletion stac/src/item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,7 @@ mod tests {

#[test]
fn deserialize_invalid_type_field() {
let mut item: Value = crate::read_json("data/simple-item.json").unwrap();
let mut item: Value = crate::io::read_json("data/simple-item.json").unwrap();
item["type"] = "Item".into(); // must be "Feature"
assert!(serde_json::from_value::<Item>(item).is_err());
}
Expand Down
2 changes: 1 addition & 1 deletion stac/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ pub use {
extensions::{Extension, Extensions},
fields::Fields,
href::{href_to_url, Href},
io::{read, read_json},
io::read,
item::{FlatItem, Item, Properties, ITEM_TYPE},
item_collection::{ItemCollection, ITEM_COLLECTION_TYPE},
link::{Link, Links},
Expand Down
2 changes: 1 addition & 1 deletion stac/src/migrate.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ mod tests {
assert_eq!(asset.bands[2].name.as_ref().unwrap(), "b");
assert_eq!(asset.bands[3].name.as_ref().unwrap(), "nir");

let expected: Value = crate::read_json("examples/bands-v1.1.0-beta.1.json").unwrap();
let expected: Value = crate::io::read_json("examples/bands-v1.1.0-beta.1.json").unwrap();
assert_json_eq!(expected, serde_json::to_value(item).unwrap());

let collection = Collection::new("an-id", "a description");
Expand Down