Struct servlin::internal::Response

pub struct Response {
    pub kind: ResponseKind,
    pub code: u16,
    pub content_type: ContentType,
    pub headers: HeaderList,
    pub body: ResponseBody,
}

Fields

kind: ResponseKind

code: u16

content_type: ContentType

headers: HeaderList

body: ResponseBody

Implementations

impl Response

pub fn new(code: u16) -> Self

pub fn drop_connection() -> Self

Return this and the server will drop the connection.

pub fn get_body_and_reprocess(max_len: u64) -> Self

Return this and the server will read the request body from the client and call the request handler again.

If the request body is larger than max_len bytes, it sends 413 Payload Too Large.

Examples found in repository

examples/http-put.rs (line 55)

fn put(state: Arc<State>, req: Request) -> Result<Response, Error> {
    if req.body.is_pending() {
        return Ok(Response::get_body_and_reprocess(1024 * 1024));
    }
    let body_len = req.body.reader()?.bytes().count();
    state.upload_count.fetch_add(1, Ordering::AcqRel);
    Ok(Response::text(
        200,
        format!(
            "Upload received, body_len={}, upload_count={}\n",
            body_len,
            state.upload_count.load(Ordering::Acquire)
        ),
    ))
}

pub fn html(code: u16, body: impl Into<ResponseBody>) -> Self

pub fn event_stream() -> (EventSender, Response)

Examples found in repository

examples/events-sse.rs (line 66)

fn subscribe(state: Arc<State>, _req: Request) -> Result<Response, Error> {
    let (sender, response) = Response::event_stream();
    state.subscribers.lock().unwrap().push(sender);
    Ok(response)
}

pub fn text(code: u16, body: impl Into<ResponseBody>) -> Self

Examples found in repository

examples/events-sse.rs (line 74)

fn handle_req(state: Arc<State>, req: Request) -> Result<Response, Error> {
    match (req.method(), req.url().path()) {
        ("GET", "/health") => Ok(Response::text(200, "ok")),
        ("GET", "/subscribe") => subscribe(state, req),
        _ => Ok(Response::text(404, "Not found")),
    }
}

examples/http-put.rs (lines 59-66)

fn put(state: Arc<State>, req: Request) -> Result<Response, Error> {
    if req.body.is_pending() {
        return Ok(Response::get_body_and_reprocess(1024 * 1024));
    }
    let body_len = req.body.reader()?.bytes().count();
    state.upload_count.fetch_add(1, Ordering::AcqRel);
    Ok(Response::text(
        200,
        format!(
            "Upload received, body_len={}, upload_count={}\n",
            body_len,
            state.upload_count.load(Ordering::Acquire)
        ),
    ))
}

fn handle_req(state: Arc<State>, req: Request) -> Result<Response, Error> {
    match (req.method(), req.url().path()) {
        ("GET", "/health") => Ok(Response::text(200, "ok")),
        ("PUT", "/upload") => put(state, req),
        (_, "/upload") => Ok(Response::method_not_allowed_405(&["PUT"])),
        _ => Ok(Response::text(404, "Not found")),
    }
}

pub fn ok_200() -> Self

pub fn no_content_204() -> Self

pub fn redirect_301(location: impl AsRef<str>) -> Self

Tell the client to GET location.

The client should store this redirect.

Panics

Panics when location is not US-ASCII.

pub fn redirect_303(location: impl AsRef<str>) -> Self

Tell the client to GET location.

The client should not store this redirect.

A PUT or POST handler usually returns this.

Panics

Panics when location is not US-ASCII.

pub fn unauthorized_401() -> Self

pub fn forbidden_403() -> Self

pub fn not_found_404() -> Self

Examples found in repository

examples/minimal.rs (line 42)

pub fn main() {
    safina_timer::start_timer_thread();
    let executor = safina_executor::Executor::default();
    executor
        .block_on(
            HttpServerBuilder::new()
                .listen_addr(socket_addr_127_0_0_1(8000))
                .spawn_and_join(|_req: Request| Response::not_found_404()),
        )
        .unwrap();
}

pub fn method_not_allowed_405(allowed_methods: &[&'static str]) -> Self

Panics

Panics when any of allowed_methods are not US-ASCII.

Examples found in repository

examples/http-put.rs (line 73)

fn handle_req(state: Arc<State>, req: Request) -> Result<Response, Error> {
    match (req.method(), req.url().path()) {
        ("GET", "/health") => Ok(Response::text(200, "ok")),
        ("PUT", "/upload") => put(state, req),
        (_, "/upload") => Ok(Response::method_not_allowed_405(&["PUT"])),
        _ => Ok(Response::text(404, "Not found")),
    }
}

pub fn length_required_411() -> Self

pub fn payload_too_large_413() -> Self

pub fn unprocessable_entity_422(body: impl Into<String>) -> Self

pub fn internal_server_errror_500() -> Self

pub fn not_implemented_501() -> Self

pub fn service_unavailable_503() -> Self

pub fn with_body(self, b: impl Into<ResponseBody>) -> Self

pub fn with_max_age_seconds(self, seconds: u32) -> Self

Adds a Cache-Control: max-age=N header.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control

pub fn with_no_store(self) -> Self

Adds a Cache-Control: no-store header.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control

pub fn with_set_cookie(self, cookie: Cookie) -> Self

Adds a Set-Cookie header.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie

pub fn with_header(self, name: impl AsRef<str>, value: AsciiString) -> Self

Adds a header.

You can call this multiple times to add multiple headers with the same name.

The HTTP spec limits header names to US-ASCII and header values to US-ASCII or ISO-8859-1.

Panics

Panics when name is not US-ASCII.

Example

use servlin::Response;

return Response::new(200)
    .with_header("header1", "value1".to_string().try_into().unwrap());

pub fn with_status(self, c: u16) -> Self

pub fn with_type(self, t: ContentType) -> Self

pub fn is_1xx(&self) -> bool

pub fn is_2xx(&self) -> bool

pub fn is_3xx(&self) -> bool

pub fn is_4xx(&self) -> bool

pub fn is_5xx(&self) -> bool

pub fn is_normal(&self) -> bool

pub fn is_get_body_and_reprocess(&self) -> bool

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl From<Error> for Response

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<HttpError> for Response

fn from(e: HttpError) -> Self

Converts to this type from the input type.

impl From<Response> for Error

fn from(value: Response) -> Self

Converts to this type from the input type.

impl PartialEq for Response

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Response

impl StructuralEq for Response

impl StructuralPartialEq for Response