Skip to main content

Response

Struct Response 

Source
pub struct Response {
    pub header: ResponseHeader,
    pub body: ResponseBody,
}
Expand description

Native representation of the response wire format.

Fields§

§header: ResponseHeader

Header of the response, containing the response status.

§body: ResponseBody

Response body consists of an opaque vector of bytes. Interpretation of said bytes is deferred to the a converter which can handle the content_type defined in the header.

Implementations§

Source§

impl Response

Source

pub fn from_request_header( header: RequestHeader, status: ResponseStatus, ) -> Response

Convert request into an error response with a given ResponseStatus.

The relevant fields in the header are preserved and an empty body is provided by default.

Source

pub fn from_status(status: ResponseStatus) -> Response

Create an empty response with a specific status.

Source

pub fn write_to_stream(self, stream: &mut impl Write) -> Result<()>

Serialise response and write it to given stream.

Header is converted to a raw format before serializing.

§Errors
  • if writing any of the subfields (header or body) fails, then ResponseStatus::ConnectionError is returned.
  • if encoding any of the fields in the header fails, then ResponseStatus::InvalidEncoding is returned.
Source

pub fn read_from_stream( stream: &mut impl Read, body_len_limit: usize, ) -> Result<Response>

Deserialise response from given stream.

The body_len_limit parameter allows the interface client to reject requests that are longer than a predefined limit. The length limit is in bytes.

§Errors
  • if reading any of the subfields (header or body) fails, the corresponding ResponseStatus will be returned.
  • if the request body size specified in the header is larger than the limit passed as a parameter, BodySizeExceedsLimit will be returned.

Trait Implementations§

Source§

impl Debug for Response

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Response

Source§

impl PartialEq for Response

Source§

fn eq(&self, other: &Response) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Response

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