Enum stac::Format

pub enum Format {
    Json(bool),
    NdJson,
    Geoparquet(Option<Compression>),
}

The format of STAC data.

Variants

Json(bool)

JSON data (the default).

If true, the data will be pretty-printed on write.

NdJson

Newline-delimited JSON.

Geoparquet(Option<Compression>)

stac-geoparquet

Implementations

impl Format

pub fn infer_from_href(href: &str) -> Option<Format>

Infer the format from a file extension.

Examples

use stac::Format;

assert_eq!(Format::Json(false), Format::infer_from_href("item.json").unwrap());

pub fn read<T: Href + FromJson + FromNdjson + FromGeoparquet>( &self, href: impl ToString, ) -> Result<T>

Reads a STAC object from an href in this format.

Examples

use stac::{Format, Item};

let item: Item = Format::json().read("examples/simple-item.json").unwrap();

pub fn from_path<T: FromJson + FromNdjson + FromGeoparquet + Href>( &self, path: impl AsRef<Path>, ) -> Result<T>

Reads a local file in the given format.

Examples

use stac::{Format, Item};

let item: Item = Format::json().from_path("examples/simple-item.json").unwrap();

pub fn from_bytes<T: FromJson + FromNdjson + FromGeoparquet>( &self, bytes: impl Into<Bytes>, ) -> Result<T>

Reads a STAC object from some bytes.

Examples

use stac::{Format, Item};
use std::{io::Read, fs::File};

let mut buf = Vec::new();
File::open("examples/simple-item.json").unwrap().read_to_end(&mut buf).unwrap();
let item: Item = Format::json().from_bytes(buf).unwrap();

pub async fn get_opts<T, I, K, V>( &self, href: impl ToString, options: I, ) -> Result<T>

where T: Href + FromJson + FromNdjson + FromGeoparquet, I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: Into<String>,

Available on crate feature object-store only.

Gets a STAC value from an object store with the provided options.

Examples

use stac::{Item, Format};

#[cfg(feature = "object-store-aws")]
{
    let item: Item = stac::io::get_opts("s3://bucket/item.json", [("aws_access_key_id", "...")]).await.unwrap();
}

pub fn write<T: ToJson + ToNdjson + IntoGeoparquet>( &self, path: impl AsRef<Path>, value: T, ) -> Result<()>

Writes a STAC value to the provided path.

Examples

use stac::{Item, Format};

Format::json().write("an-id.json", Item::new("an-id")).unwrap();

pub fn into_vec<T: ToJson + ToNdjson + IntoGeoparquet>( &self, value: T, ) -> Result<Vec<u8>>

Converts a STAC object into some bytes.

Examples

use stac::{Format, Item};

let item = Item::new("an-id");
let bytes = Format::json().into_vec(item).unwrap();

pub async fn put_opts<T, I, K, V>( &self, href: impl ToString, value: T, options: I, ) -> Result<Option<PutResult>>

where T: ToJson + ToNdjson + IntoGeoparquet, I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: Into<String>,

Available on crate feature object-store only.

Puts a STAC value to an object store with the provided options.

Examples

use stac::{Item, Format};

let item = Item::new("an-id");
#[cfg(feature = "object-store-aws")]
{
    Format::json().put_opts("s3://bucket/item.json", item, [("aws_access_key_id", "...")]).await.unwrap();
}

pub fn json() -> Format

Returns the default JSON format (compact).

pub fn ndjson() -> Format

Returns the newline-delimited JSON format.

pub fn geoparquet() -> Format

Available on crate feature geoparquet only.

Returns the default geoparquet format (no compression specified).

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Format

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Format

fn default() -> Self

Returns the “default value” for a type.

impl Display for Format

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Format

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Format>

Parses a string s to return a value of this type.

impl PartialEq for Format

fn eq(&self, other: &Format) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Format

impl StructuralPartialEq for Format