Struct crux_http::Http

source ·
pub struct Http<Ev> { /* private fields */ }
Expand description

The Http capability API.

Implementations§

source§

impl<Ev> Http<Ev>
where Ev: 'static,

source

pub fn new(context: CapabilityContext<HttpRequest, Ev>) -> Self

source

pub fn get(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP GET request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.get("https://httpbin.org/get").send(Event::ReceiveResponse)
source

pub fn head(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP HEAD request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.head("https://httpbin.org/get").send(Event::ReceiveResponse)
source

pub fn post(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP POST request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.post("https://httpbin.org/post").send(Event::ReceiveResponse)
source

pub fn put(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP PUT request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.put("https://httpbin.org/post").send(Event::ReceiveResponse)
source

pub fn delete(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP DELETE request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.delete("https://httpbin.org/post").send(Event::ReceiveResponse)
source

pub fn connect(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP CONNECT request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.connect("https://httpbin.org/get").send(Event::ReceiveResponse)
source

pub fn options(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP OPTIONS request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.options("https://httpbin.org/get").send(Event::ReceiveResponse)
source

pub fn trace(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP TRACE request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

§Examples
caps.http.trace("https://httpbin.org/get").send(Event::ReceiveResponse)
source

pub fn patch(&self, url: impl AsRef<str>) -> RequestBuilder<Ev>

Instruct the Shell to perform a HTTP PATCH request to the provided url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

§Panics

This will panic if a malformed URL is passed.

source

pub fn request(&self, method: Method, url: Url) -> RequestBuilder<Ev>

Instruct the Shell to perform an HTTP request with the provided method and url.

The request can be configured via associated functions on RequestBuilder and then sent with RequestBuilder::send

When finished, the response will be wrapped in an event and dispatched to the app’s `update function.

Trait Implementations§

source§

impl<Ev> Capability<Ev> for Http<Ev>

§

type Operation = HttpRequest

§

type MappedSelf<MappedEv> = Http<MappedEv>

source§

fn map_event<F, NewEv>(&self, f: F) -> Self::MappedSelf<NewEv>
where F: Fn(NewEv) -> Ev + Send + Sync + 'static, Ev: 'static, NewEv: 'static,

source§

impl<Ev> Clone for Http<Ev>

source§

fn clone(&self) -> Self

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

Auto Trait Implementations§

§

impl<Ev> Freeze for Http<Ev>

§

impl<Ev> !RefUnwindSafe for Http<Ev>

§

impl<Ev> Send for Http<Ev>

§

impl<Ev> Sync for Http<Ev>

§

impl<Ev> Unpin for Http<Ev>

§

impl<Ev> !UnwindSafe for Http<Ev>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

§

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>,

§

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>,

§

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V