Struct Client

Source
pub struct Client(pub Client);
๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates
Expand description

A thin wrapper around reqwest::Client.

Tuple Fieldsยง

ยง0: Client
๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates

Implementationsยง

Sourceยง

impl Client

Source

pub fn new() -> Client

๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates

Creates a new client.

ยงExamples
let client = stac_async::Client::new();
ยงCustom client

You can construct the client directly using a pre-built reqwest::Client, e.g. to do authorization:

use reqwest::header;
let mut headers = header::HeaderMap::new();
let mut auth_value = header::HeaderValue::from_static("secret");
auth_value.set_sensitive(true);
headers.insert(header::AUTHORIZATION, auth_value);
let client = reqwest::Client::builder().default_headers(headers).build().unwrap();
let client = stac_async::Client(client);
Source

pub async fn get<V>(&self, url: impl IntoUrl) -> Result<Option<V>, Error>

๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates

Gets a STAC value from a url.

Also sets that Values href. Returns Ok(None) if a 404 is returned from the server.

ยงExamples
let client = stac_async::Client::new();
let href = "https://raw.githubusercontent.com/radiantearth/stac-spec/v1.0.0/examples/simple-item.json";
let item: stac::Item = client.get(href).await.unwrap().unwrap();
Source

pub async fn post<S, R>( &self, url: impl IntoUrl, data: &S, ) -> Result<Option<R>, Error>
where S: Serialize + 'static, R: DeserializeOwned,

๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates

Posts data to a url.

ยงExamples
use stac_api::Search;
let client = stac_async::Client::new();
let href = "https://planetarycomputer.microsoft.com/api/stac/v1/search";
let mut search = Search::default();
search.items.limit = Some(1);
let items: stac_api::ItemCollection = client.post(href, &search).await.unwrap().unwrap();
Source

pub async fn request<S, R>( &self, method: Method, url: impl IntoUrl, params: impl Into<Option<&S>>, headers: impl Into<Option<HeaderMap>>, ) -> Result<Option<R>, Error>
where S: Serialize + 'static, R: DeserializeOwned,

๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates

Sends a request to a url.

ยงExamples
use stac::Item;
use reqwest::Method;

let client = stac_async::Client::new();
let href = "https://raw.githubusercontent.com/radiantearth/stac-spec/v1.0.0/examples/simple-item.json";
let item = client.request::<(), Item>(Method::GET, href, None, None).await.unwrap().unwrap();
๐Ÿ‘ŽDeprecated: use stac instead of stac-async, which is deprecated and will receive no further updates

Builds and sends a request, as defined in a link.

Used mostly for โ€œnextโ€ links in pagination.

ยงExamples
use stac::Link;
let link = Link::new("http://stac-async-rs.test/search?foo=bar", "next");
let client = stac_async::Client::new();
let page: stac_api::ItemCollection = client.request_from_link(link).await.unwrap().unwrap();

Trait Implementationsยง

Sourceยง

impl Clone for Client

Sourceยง

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Debug for Client

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Default for Client

Sourceยง

fn default() -> Self

Returns the โ€œdefault valueโ€ for a type. Read more

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

impl<T> ErasedDestructor for T
where T: 'static,