Struct stac_api::UrlBuilder

pub struct UrlBuilder { /* private fields */ }

Builds urls on a root url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test/api/v1").unwrap();
assert_eq!(
    url_builder.items("my-great-collection").unwrap().as_str(),
    "http://stac-api.test/api/v1/collections/my-great-collection/items"
);

Implementations

impl UrlBuilder

pub fn new(url: &str) -> Result<UrlBuilder, ParseError>

Creates a new url builder.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();

pub fn root(&self) -> &Url

Returns the root url.

The root url always has a trailing slash, even if the builder was created without one.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(url_builder.root().as_str(), "http://stac-api.test/");

pub fn collections(&self) -> &Url

Returns the collections url.

This url is created when the builder is created, so it can’t error.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(url_builder.collections().as_str(), "http://stac-api.test/collections");

pub fn collection(&self, id: &str) -> Result<Url, ParseError>

Returns a collection url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(
    url_builder.collection("a-collection").unwrap().as_str(),
    "http://stac-api.test/collections/a-collection"
);

pub fn items(&self, id: &str) -> Result<Url, ParseError>

Returns an items url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(
    url_builder.items("a-collection").unwrap().as_str(),
    "http://stac-api.test/collections/a-collection/items"
);

pub fn item(&self, collection_id: &str, id: &str) -> Result<Url, ParseError>

Returns a item url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(
    url_builder.item("a-collection", "an-item").unwrap().as_str(),
    "http://stac-api.test/collections/a-collection/items/an-item"
);

pub fn conformance(&self) -> &Url

Returns the conformance url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(
    url_builder.conformance().as_str(),
    "http://stac-api.test/conformance"
);

pub fn service_desc(&self) -> &Url

Returns the service-desc url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(
    url_builder.service_desc().as_str(),
    "http://stac-api.test/api"
);

pub fn search(&self) -> &Url

Returns the search url.

Examples

let url_builder = UrlBuilder::new("http://stac-api.test").unwrap();
assert_eq!(
    url_builder.search().as_str(),
    "http://stac-api.test/search"
);

Trait Implementations

impl Clone for UrlBuilder

fn clone(&self) -> UrlBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UrlBuilder

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

Formats the value using the given formatter.

impl FromStr for UrlBuilder

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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