Enum Response 

pub enum Response<T> {
    Body(T),
    WithStatus(StatusCode, T),
    Raw(StatusCode, Body),
    Empty,
    WithCookies(Box<Response<T>>, Vec<Cookie>),
}

Re-exported public API. Public Caelix enumeration Response.

Variants

Body(T)

Public Caelix API.

WithStatus(StatusCode, T)

Public Caelix API.

Raw(StatusCode, Body)

Public Caelix API.

Empty

Public Caelix API.

WithCookies(Box<Response<T>>, Vec<Cookie>)

Adds cookies after materializing the wrapped response.

Implementations

impl<T> Response<T>

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

Appends a cookie while preserving call order.

impl Response<()>

pub fn no_content() -> Self

Runs the no_content public API operation.

pub fn text(status: StatusCode, value: impl Into<String>) -> Self

Runs the text public API operation.

pub fn bytes(status: StatusCode, value: impl Into<Vec<u8>>) -> Self

Runs the bytes public API operation.

pub fn json(status: StatusCode, value: impl Serialize) -> Self

Runs the json public API operation.

pub fn stream( content_type: &'static str, stream: impl Stream<Item = Result<Bytes>> + Send + 'static, ) -> HttpResponse

Stream response chunks as they become ready (chunked transfer encoding is applied by the HTTP adapter).

pub fn sse<T>( stream: impl Stream<Item = Result<T>> + Send + 'static, ) -> HttpResponse

where T: Serialize + 'static,

Server-Sent Events: each item is serialized as JSON and framed as data: <json>\n\n with content type text/event-stream.

Also sets Cache-Control: no-cache and X-Accel-Buffering: no so proxies/browsers do not buffer the stream. Does not yet implement the full SSE protocol (id:, event:, retry:, Last-Event-ID).

pub async fn file( path: impl AsRef<Path>, content_type: &'static str, ) -> Result<HttpResponse>

Stream a file from disk in chunks (not loaded fully into memory).

Open errors: NotFound → 404, PermissionDenied → 403, other IO → 500.

Trait Implementations

impl<T: Serialize> IntoCaelixResponse for Response<T>

fn into_response(self) -> HttpResponse

Public Caelix API.