Struct oxhttp::Client

source ·
pub struct Client { /* private fields */ }
Expand description

An HTTP client.

It aims at following the basic concepts of the Web Fetch standard without the bits specific to web browsers (context, CORS…).

HTTPS is supported behind the disabled by default native-tls feature (to use the current system native implementation) or rustls feature (to use Rustls).

The client does not follow redirections by default. Use Client::set_redirection_limit to set a limit to the number of consecutive redirections the server should follow.

Missing: HSTS support, authentication and keep alive.

use oxhttp::Client;
use oxhttp::model::{Request, Method, Status, HeaderName};
use std::io::Read;

let client = Client::new();
let response = client.request(Request::builder(Method::GET, "http://example.com".parse()?).build())?;
assert_eq!(response.status(), Status::OK);
assert_eq!(response.header(&HeaderName::CONTENT_TYPE).unwrap().as_ref(), b"text/html; charset=UTF-8");
let body = response.into_body().to_string()?;

Implementations§

source§

impl Client

source

pub fn new() -> Self

source

pub fn set_global_timeout(&mut self, timeout: Duration)

Sets the global timeout value (applies to both read, write and connection).

source

pub fn set_user_agent( &mut self, user_agent: impl Into<String> ) -> Result<(), InvalidHeader>

Sets the default value for the User-Agent header.

source

pub fn set_redirection_limit(&mut self, limit: usize)

Sets the number of time a redirection should be followed. By default the redirections are not followed (limit = 0).

source

pub fn request(&self, request: Request) -> Result<Response>

Trait Implementations§

source§

impl Default for Client

source§

fn default() -> Client

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.