Struct Response 

pub struct Response {
    pub status: Status,
    pub headers: ResponseHeaders,
    /* private fields */
}

HTTP Response

Composed of

• status
• headers
• content

Usage

in_fang.rs

use ohkami::prelude::*;

#[derive(Clone)]
struct SetHeaders;
impl FangAction for SetHeaders {
    async fn back<'a>(&'a self, res: &'a mut Response) {
        res.headers.set()
            .server("ohkami")
            .vary("Origin");
    }
}

#[tokio::main]
async fn main() {
    Ohkami::new((SetHeaders,
        "/".GET(|| async {"Hello, ohkami!"})
    )).howl("localhost:5050").await
}

---

into_response.rs

use ohkami::{Response, IntoResponse, Status};

enum AppError {
    A(String),
    B(String),
}
impl IntoResponse for AppError {
    fn into_response(self) -> Response {
        match self {
            Self::A(msg) => Response::InternalServerError().with_text(msg),
            Self::B(msg) => Response::BadRequest().with_text(msg),
        }
    }
}

async fn handler(id: usize) -> Result<String, AppError> {
    if id == 0 {
        return Err(AppError::B("id must be positive".into()))
    }

    Ok("Hello, Response!".into())
}

Fields

status: Status

HTTP status of this response

headers: ResponseHeaders

Headers of this response

• .{name}(), .get("{name}") to get value
• .set().{name}({action}), .set().x("{name}", {action}) to mutate values

---

{action}:

• just {value} to insert
• None to remove
• header::append({value}) to append

{value}:

• String
• &'static str
• Cow<'static, str>
• Some(Cow<'static, str>)

Implementations

impl Response

pub fn Continue() -> Self

100 Continue empty Response

pub fn SwitchingProtocols() -> Self

101 Switching Protocols empty Response

pub fn Processing() -> Self

102 Processing empty Response

pub fn EarlyHints() -> Self

103 Early Hints empty Response

pub fn OK() -> Self

200 OK empty Response

pub fn Created() -> Self

201 Created empty Response

pub fn Accepted() -> Self

202 Accepted empty Response

pub fn NonAuthoritativeInformation() -> Self

203 Non-Authoritative Information empty Response

pub fn NoContent() -> Self

204 No Content empty Response

pub fn ResetContent() -> Self

205 Reset Content empty Response

pub fn PartialContent() -> Self

206 Partial Content empty Response

pub fn MultiStatus() -> Self

207 Multi-Status empty Response

pub fn AlreadyReported() -> Self

208 Already Reported empty Response

pub fn IMUsed() -> Self

226 IMUsed empty Response

pub fn MultipleChoice() -> Self

300 Multiple Choice empty Response

pub fn MovedPermanently() -> Self

301 Moved Permanently empty Response

pub fn Found() -> Self

302 Found empty Response

pub fn SeeOther() -> Self

303 See Other empty Response

pub fn NotModified() -> Self

304 Not Modifed empty Response

pub fn TemporaryRedirect() -> Self

307 Temporary Redirect empty Response

pub fn PermanentRedirect() -> Self

308 Permanent Redirect empty Response

pub fn BadRequest() -> Self

400 Bad Request empty Response

pub fn Unauthorized() -> Self

401 Unauthorized empty Response

pub fn Forbidden() -> Self

403 Forbidden empty Response

pub fn NotFound() -> Self

404 Not Found empty Response

pub fn MethodNotAllowed() -> Self

405 Method Not Allowed empty Response

pub fn NotAcceptable() -> Self

406 Not Acceptable empty Response

pub fn ProxyAuthenticationRequired() -> Self

407 Proxy Authentication Required empty Response

pub fn RequestTimeout() -> Self

408 Request Timeout empty Response

pub fn Conflict() -> Self

409 Conflict empty Response

pub fn Gone() -> Self

410 Gone empty Response

pub fn LengthRequired() -> Self

411 Length Required empty Response

pub fn PreconditionFailed() -> Self

412 Precondition Failed empty Response

pub fn PayloadTooLarge() -> Self

413 Payload Too Large empty Response

pub fn URITooLong() -> Self

414 URI Too Long empty Response

pub fn UnsupportedMediaType() -> Self

415 Unsupported Media Type empty Response

pub fn RangeNotSatisfiable() -> Self

416 Range Not Satisfiable empty Response

pub fn ExceptionFailed() -> Self

417 Exception Failed empty Response

pub fn ImATeapot() -> Self

418 I'm a teapot empty Response

pub fn MisdirectedRequest() -> Self

421 Misdirected Request empty Response

pub fn UnprocessableEntity() -> Self

422 Unprocessable Entity empty Response

pub fn Locked() -> Self

423 Locked empty Response

pub fn FailedDependency() -> Self

424 Failed Dependency empty Response

pub fn UpgradeRequired() -> Self

426 UpgradeRequired empty Response

pub fn PreconditionRequired() -> Self

428 Precondition Required empty Response

pub fn TooManyRequest() -> Self

429 Too Many Request empty Response

pub fn RequestHeaderFieldsTooLarge() -> Self

431 Request Header Fields Too Large empty Response

pub fn UnavailableForLegalReasons() -> Self

451 Unavailable For Legal Reasons empty Response

pub fn InternalServerError() -> Self

500 Internal Server Error empty Response

pub fn NotImplemented() -> Self

501 Not Implemented empty Response

pub fn BadGateway() -> Self

502 Bad Gateway empty Response

pub fn ServiceUnavailable() -> Self

503 Service Unavailable empty Response

pub fn GatewayTimeout() -> Self

504 Gateway Timeout empty Response

pub fn HTTPVersionNotSupported() -> Self

505 HTTP Version Not Supported empty Response

pub fn VariantAlsoNegotiates() -> Self

506 Variant Also Negotiates empty Response

pub fn InsufficientStorage() -> Self

507 Unsufficient Storage empty Response

pub fn LoopDetected() -> Self

508 Loop Detected empty Response

pub fn NotExtended() -> Self

510 Not Extended empty Response

pub fn NetworkAuthenticationRequired() -> Self

511 Network Authentication Required empty Response

impl Response

pub fn new(status: Status) -> Self

impl Response

pub fn with_headers( self, f: impl FnOnce(SetHeaders<'_>) -> SetHeaders<'_>, ) -> Self

pub fn drop_content(&mut self) -> Content

pub fn without_content(self) -> Self

pub fn set_payload( &mut self, content_type: &'static str, content: impl Into<Cow<'static, [u8]>>, )

pub fn with_payload( self, content_type: &'static str, content: impl Into<Cow<'static, [u8]>>, ) -> Self

pub fn payload(&self) -> Option<&[u8]>

pub fn set_text<Text: Into<Cow<'static, str>>>(&mut self, text: Text)

pub fn with_text<Text: Into<Cow<'static, str>>>(self, text: Text) -> Self

pub fn set_html<HTML: Into<Cow<'static, str>>>(&mut self, html: HTML)

pub fn with_html<HTML: Into<Cow<'static, str>>>(self, html: HTML) -> Self

pub fn set_json<JSON: Serialize>(&mut self, json: JSON)

pub fn with_json<JSON: Serialize>(self, json: JSON) -> Self

pub unsafe fn set_json_lit<JSONLiteral: Into<Cow<'static, str>>>( &mut self, json_lit: JSONLiteral, )

SAFETY

argument json_lit must be valid JSON

pub unsafe fn with_json_lit<JSONLiteral: Into<Cow<'static, str>>>( self, json_lit: JSONLiteral, ) -> Self

SAFETY

argument json_lit must be valid JSON

impl Response

pub fn with_stream<T: Data>( self, stream: impl Stream<Item = T> + Unpin + Send + 'static, ) -> Self

Available on crate feature sse only.

pub fn set_stream<T: Data>( &mut self, stream: impl Stream<Item = T> + Unpin + Send + 'static, )

Available on crate feature sse only.

pub fn set_stream_raw( &mut self, stream: Pin<Box<dyn Stream<Item = String> + Send>>, )

Available on crate feature sse only.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl FromResidual<Result<Infallible, Response>> for Response

Available on crate feature nightly only.

fn from_residual(residual: Result<Infallible, Response>) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from a compatible Residual type.

impl IntoResponse for Response

fn into_response(self) -> Response

impl PartialEq for Response

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.