Struct EndpointResponse 

pub struct EndpointResponse { /* private fields */ }

A returned value or intentional API error, available to completed endpoint hooks.

Implementations

impl EndpointResponse

pub fn value(value: JsValue) -> Self

pub fn json(value: &impl Serialize) -> AuthResult<Self>

Errors

Returns an error if the endpoint value cannot be serialized.

pub fn empty() -> Self

Return no logical value and an empty successful HTTP response.

pub fn from_http_response(response: AuthResponse) -> Self

Return an actual HTTP response value, retaining its bytes, status and headers.

Endpoint hooks still run. Accumulated hook headers and status remain separate from this response until it is forwarded to HTTP.

pub const fn http_response(&self) -> Option<&AuthResponse>

pub fn http_response_mut(&mut self) -> Option<&mut AuthResponse>

pub fn to_response(&self) -> AuthResult<AuthResponse>

Forward the returned value as HTTP, preserving a response value’s own status and body.

Errors

Returns a serialization error for a JSON value or an intentional API error.

pub fn error(error: AuthError) -> Self

pub fn redirect(location: impl Into<String>) -> Self

Preserve an intentional redirect error, including its absent body and Location.

pub fn without_error_body(self) -> Self

Retain the distinction between an absent error body and an explicit JSON null.

pub const fn error_body_is_absent(&self) -> bool

pub fn with_error_body(self, body: JsValue) -> Self

pub const fn error_body(&self) -> Option<&JsValue>

pub const fn result(&self) -> &Result<JsValue, AuthError>

pub const fn headers(&self) -> &Headers

pub const fn status(&self) -> Option<u16>

pub fn set_status(&mut self, status: Option<u16>)

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

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

pub fn merge_headers(&mut self, headers: Headers)

pub fn replace(&mut self, value: JsValue)

Replace a returned value while retaining the actual handler status and headers.

pub fn replace_error(&mut self, error: AuthError)

pub fn into_output<T>(self) -> Result<EndpointOutput<T>, EndpointError>

Trait Implementations

impl Debug for EndpointResponse

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

Formats the value using the given formatter.