Struct lucas_test::api::http::HttpRequestBuilder

source · [−]

pub struct HttpRequestBuilder {
    pub method: String,
    pub url: Url,
    pub query: Option<HashMap<String, String>>,
    pub headers: Option<HashMap<String, String>>,
    pub body: Option<Body>,
    pub timeout: Option<u64>,
    pub response_type: Option<ResponseType>,
}

This is supported on crate feature http-api only.

Expand description

The builder for a HTTP request.

Examples

use tauri::api::http::{HttpRequestBuilder, ResponseType, ClientBuilder};
async fn run() {
  let client = ClientBuilder::new()
    .max_redirections(3)
    .build()
    .unwrap();
  let request = HttpRequestBuilder::new("GET", "http://example.com").unwrap()
    .response_type(ResponseType::Text);
  if let Ok(response) = client.send(request).await {
    println!("got response");
  } else {
    println!("Something Happened!");
  }
}

Fields

method: String

The request method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, CONNECT or TRACE)

url: Url

The request URL

query: Option<HashMap<String, String>>

The request query params

headers: Option<HashMap<String, String>>

The request headers

body: Option<Body>

The request body

timeout: Option<u64>

Timeout for the whole request

response_type: Option<ResponseType>

The response type (defaults to Json)

Implementations

impl HttpRequestBuilder

pub fn new(method: impl Into<String>, url: impl AsRef<str>) -> Result<Self>

Initializes a new instance of the HttpRequestrequest_builder.

pub fn query(self, query: HashMap<String, String>) -> Self

Sets the request parameters.

pub fn headers(self, headers: HashMap<String, String>) -> Self

Sets the request headers.

pub fn body(self, body: Body) -> Self

Sets the request body.

pub fn timeout(self, timeout: u64) -> Self

Sets the general request timeout.

pub fn response_type(self, response_type: ResponseType) -> Self

Sets the type of the response. Interferes with the way we read the response.

Trait Implementations

impl Debug for HttpRequestBuilder

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for HttpRequestBuilder

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for HttpRequestBuilder

impl Send for HttpRequestBuilder

impl Sync for HttpRequestBuilder

impl Unpin for HttpRequestBuilder

impl UnwindSafe for HttpRequestBuilder

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<'de, D, R> CommandArg<'de, R> for D where
D: Deserialize<'de>,
R: Runtime,

fn from_command(command: CommandItem<'de, R>) -> Result<Self, InvokeError>

Derives an instance of Self from the CommandItem. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,