Struct actix_web::HttpResponse

pub struct HttpResponse(_, _);

Expand description

An HTTP Response

Implementations

impl HttpResponse

pub fn Ok() -> HttpResponseBuilder

pub fn Created() -> HttpResponseBuilder

pub fn Accepted() -> HttpResponseBuilder

pub fn NonAuthoritativeInformation() -> HttpResponseBuilder

pub fn NoContent() -> HttpResponseBuilder

pub fn ResetContent() -> HttpResponseBuilder

pub fn PartialContent() -> HttpResponseBuilder

pub fn MultiStatus() -> HttpResponseBuilder

pub fn AlreadyReported() -> HttpResponseBuilder

pub fn MultipleChoices() -> HttpResponseBuilder

pub fn MovedPermanenty() -> HttpResponseBuilder

pub fn MovedPermanently() -> HttpResponseBuilder

pub fn Found() -> HttpResponseBuilder

pub fn SeeOther() -> HttpResponseBuilder

pub fn NotModified() -> HttpResponseBuilder

pub fn UseProxy() -> HttpResponseBuilder

pub fn TemporaryRedirect() -> HttpResponseBuilder

pub fn PermanentRedirect() -> HttpResponseBuilder

pub fn BadRequest() -> HttpResponseBuilder

pub fn NotFound() -> HttpResponseBuilder

pub fn Unauthorized() -> HttpResponseBuilder

pub fn PaymentRequired() -> HttpResponseBuilder

pub fn Forbidden() -> HttpResponseBuilder

pub fn MethodNotAllowed() -> HttpResponseBuilder

pub fn NotAcceptable() -> HttpResponseBuilder

pub fn ProxyAuthenticationRequired() -> HttpResponseBuilder

pub fn RequestTimeout() -> HttpResponseBuilder

pub fn Conflict() -> HttpResponseBuilder

pub fn Gone() -> HttpResponseBuilder

pub fn LengthRequired() -> HttpResponseBuilder

pub fn PreconditionFailed() -> HttpResponseBuilder

pub fn PayloadTooLarge() -> HttpResponseBuilder

pub fn UriTooLong() -> HttpResponseBuilder

pub fn UnsupportedMediaType() -> HttpResponseBuilder

pub fn RangeNotSatisfiable() -> HttpResponseBuilder

pub fn ExpectationFailed() -> HttpResponseBuilder

pub fn InternalServerError() -> HttpResponseBuilder

pub fn NotImplemented() -> HttpResponseBuilder

pub fn BadGateway() -> HttpResponseBuilder

pub fn ServiceUnavailable() -> HttpResponseBuilder

pub fn GatewayTimeout() -> HttpResponseBuilder

pub fn VersionNotSupported() -> HttpResponseBuilder

pub fn VariantAlsoNegotiates() -> HttpResponseBuilder

pub fn InsufficientStorage() -> HttpResponseBuilder

pub fn LoopDetected() -> HttpResponseBuilder

impl HttpResponse

pub fn build(status: StatusCode) -> HttpResponseBuilder

Create http response builder with specific status.

pub fn build_from<T: Into<HttpResponseBuilder>>(
source: T
) -> HttpResponseBuilder

Create http response builder

pub fn new(status: StatusCode) -> HttpResponse

Constructs a response

pub fn with_body<B: Into<Body>>(status: StatusCode, body: B) -> HttpResponse

Constructs a response with body

pub fn from_error(error: Error) -> HttpResponse

Constructs an error response

pub fn into_builder(self) -> HttpResponseBuilder

Convert HttpResponse to a HttpResponseBuilder

pub fn error(&self) -> Option<&Error>

The source error for this response

pub fn version(&self) -> Option<Version>

Get the HTTP version of this response

pub fn headers(&self) -> &HeaderMap

Get the headers from the response

pub fn headers_mut(&mut self) -> &mut HeaderMap

Get a mutable reference to the headers

pub fn cookies(&self) -> CookieIter<'_>

Get an iterator for the cookies set by this response

pub fn add_cookie(&mut self, cookie: &Cookie<'_>) -> Result<(), HttpError>

Add a cookie to this response

pub fn del_cookie(&mut self, name: &str) -> usize

Remove all cookies with the given name from this response. Returns the number of cookies removed.

pub fn status(&self) -> StatusCode

Get the response status code

pub fn status_mut(&mut self) -> &mut StatusCode

Set the StatusCode for this response

pub fn reason(&self) -> &str

Get custom reason for the response

pub fn set_reason(&mut self, reason: &'static str) -> &mut Self

Set the custom reason for the response

pub fn set_connection_type(&mut self, conn: ConnectionType) -> &mut Self

Set connection type

pub fn upgrade(&self) -> bool

Connection upgrade status

pub fn keep_alive(&self) -> Option<bool>

Keep-alive status for this connection

pub fn chunked(&self) -> Option<bool>

is chunked encoding enabled

pub fn content_encoding(&self) -> Option<ContentEncoding>

Content encoding

pub fn set_content_encoding(&mut self, enc: ContentEncoding) -> &mut Self

Set content encoding

pub fn body(&self) -> &Body

Get body os this response

pub fn set_body<B: Into<Body>>(&mut self, body: B)

Set a body

pub fn replace_body<B: Into<Body>>(&mut self, body: B) -> Body

Set a body and return previous body value

pub fn response_size(&self) -> u64

Size of response in bytes, excluding HTTP headers

pub fn write_buffer_capacity(&self) -> usize

Get write buffer capacity

pub fn set_write_buffer_capacity(&mut self, cap: usize)

Set write buffer capacity

Trait Implementations

impl Debug for HttpResponse

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

Formats the value using the given formatter. Read more

impl<'a> From<&'a String> for HttpResponse

fn from(val: &'a String) -> Self

Converts to this type from the input type.

impl From<&'static [u8]> for HttpResponse

fn from(val: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<&'static str> for HttpResponse

fn from(val: &'static str) -> Self

Converts to this type from the input type.

impl From<Bytes> for HttpResponse

fn from(val: Bytes) -> Self

Converts to this type from the input type.

impl From<BytesMut> for HttpResponse

fn from(val: BytesMut) -> Self

Converts to this type from the input type.

impl From<Error> for HttpResponse

Convert Error to a HttpResponse instance

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<HttpResponseBuilder> for HttpResponse

fn from(builder: HttpResponseBuilder) -> Self

Converts to this type from the input type.

impl<I: Into<HttpResponse>, E: Into<Error>> From<Result<I, E>> for HttpResponse

Helper converters

fn from(res: Result<I, E>) -> Self

Converts to this type from the input type.

impl From<String> for HttpResponse

fn from(val: String) -> Self

Converts to this type from the input type.

impl Responder for HttpResponse

type Item = AsyncResult<HttpResponse, Error>

The associated item which can be returned.

type Error = Error

The associated error which can be returned.

fn respond_to<S>(
self,
_: &HttpRequest<S>
) -> Result<AsyncResult<HttpResponse>, Error>

Convert itself to AsyncResult or Error.

Auto Trait Implementations

impl !RefUnwindSafe for HttpResponse

impl !Send for HttpResponse

impl !Sync for HttpResponse

impl Unpin for HttpResponse

impl !UnwindSafe for HttpResponse

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

fn vzip(self) -> V

impl<T> Erased for T