Skip to main content

Response

Struct Response 

Source
pub struct Response { /* private fields */ }
Expand description

HTTP response wrapper providing convenience methods for body consumption.

Implementations§

Source§

impl Response

Source

pub fn status(&self) -> StatusCode

HTTP status code.

Source

pub fn headers(&self) -> &HeaderMap

Response headers.

Source

pub fn header(&self, name: &str) -> Option<&str>

Return the first value of the named response header as a UTF-8 string, or None if the header is absent or its value is not valid UTF-8.

§Example
use oxihttp_client::Client;

let client = Client::builder().build()?;
let resp = client.get("http://example.com/new-resource")?.send().await?;
if let Some(location) = resp.header("location") {
    println!("redirected to: {location}");
}
if let Some(nonce) = resp.header("replay-nonce") {
    println!("ACME nonce: {nonce}");
}
Source

pub fn version(&self) -> Version

HTTP version used for this response.

Source

pub fn content_length(&self) -> Option<u64>

Content-Length header as u64 if present and valid.

Source

pub async fn body_bytes(self) -> Result<Bytes, OxiHttpError>

Consume the body and return raw bytes, auto-decompressing if enabled.

Source

pub async fn body_text(self) -> Result<String, OxiHttpError>

Consume the body and return it as a UTF-8 string.

Source

pub async fn body_json<T: DeserializeOwned>(self) -> Result<T, OxiHttpError>

Consume the body and deserialize it as JSON.

Source

pub fn error_for_status(self) -> Result<Self, OxiHttpError>

Return an error if the response status is a client (4xx) or server (5xx) error.

Returns Ok(self) for success and redirect status codes.

Source

pub fn content_type(&self) -> Option<&str>

Returns the Content-Type header value as a string, if present.

Source

pub fn cookies(&self) -> Vec<Cookie>

Parse all Set-Cookie response headers using oxihttp_core::Cookie::parse_set_cookie.

Returns an empty Vec when there are no Set-Cookie headers or none parse successfully.

Source

pub fn body_stream(self) -> BodyStream

Consume the response and return the body as an async stream of chunks.

Trait Implementations§

Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. 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> 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, 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