Struct edm_core::response::Response

impl<S: ResponseCode> Response<S>

pub fn new(code: S) -> Self

Creates a new instance.

pub fn with_context<Ctx: RequestContext>(code: S, ctx: &Ctx) -> Self

Creates a new instance with the request context.

pub fn context<Ctx: RequestContext>(self, ctx: &Ctx) -> Self

Provides the request context for the response.

pub fn render<T: Serialize>(self, template_name: &str, data: T) -> Self

Available on crate feature view only.

Renders a template and sets it as the reponse data.

pub fn set_code(&mut self, code: S)

Sets the response code.

pub fn set_status_code(&mut self, status_code: impl Into<u16>)

Sets the status code.

pub fn set_error_code(&mut self, error_code: impl Into<S::ErrorCode>)

Sets the error code.

pub fn set_business_code(&mut self, business_code: impl Into<S::BusinessCode>)

Sets the bussiness code.

pub fn set_instance(&mut self, instance: impl Into<SharedString>)

Sets a URI reference that identifies the specific occurrence of the problem.

pub fn set_message(&mut self, message: impl Into<SharedString>)

Sets the message. If the response is not successful, it should be a human-readable explanation specific to this occurrence of the problem.

pub fn set_error_message(&mut self, error: impl Into<Error>)

Sets the error message.

pub fn set_data<T: Serialize>(&mut self, data: &T)

Sets the response data.

pub fn set_json_data(&mut self, data: impl Into<JsonValue>)

Sets the JSON data.

pub fn set_bytes_data(&mut self, data: impl Into<Bytes>)

Sets the bytes data.

pub fn set_validation_data(&mut self, validation: Validation)

Sets the response data for the validation.

pub fn set_data_transformer(&mut self, transformer: DataTransformer)

Sets a transformer for the response data.

pub fn set_content_type(&mut self, content_type: impl Into<SharedString>)

Sets the content type.

Note

Currently, we have built-in support for the following values:

application/json
application/jsonlines
application/msgpack
application/octet-stream
application/problem+json
application/x-www-form-urlencoded
text/csv
text/html
text/plain

pub fn set_form_response(&mut self, data: impl Into<JsonValue>)

Sets the form data as the response body.

pub fn set_json_response(&mut self, data: impl Into<JsonValue>)

Sets the JSON data as the response body.

pub fn set_jsonlines_response(&mut self, data: impl Into<JsonValue>)

Sets the JSON Lines data as the response body.

pub fn set_msgpack_response(&mut self, data: impl Into<JsonValue>)

Sets the MsgPack data as the response body.

pub fn set_csv_response(&mut self, data: impl Into<JsonValue>)

Sets the CSV data as the response body.

pub fn set_text_response(&mut self, data: impl Into<String>)

Sets the plain text as the response body.

pub fn set_bytes_response(&mut self, data: impl Into<Bytes>)

Sets the bytes data as the response body.

pub fn set_cookie(&mut self, cookie: &Cookie<'_>)

Sends a cookie to the user agent.

pub fn record_server_timing( &mut self, name: impl Into<SharedString>, description: Option<SharedString>, duration: Option<Duration> )

Records a server timing metric entry.

pub fn insert_header( &mut self, name: impl Into<SharedString>, value: impl ToString )

Inserts a custom header.

pub fn get_header(&self, name: &str) -> Option<&str>

Gets a custome header with the given name.

pub fn status_code(&self) -> u16

Returns the status code as u16.

pub fn error_code(&self) -> Option<&S::ErrorCode>

Returns the error code.

pub fn business_code(&self) -> Option<&S::BusinessCode>

Returns the business code.

pub fn is_success(&self) -> bool

Returns true if the response is successful or false otherwise.

pub fn has_context(&self) -> bool

Returns true if the response has a request context.

pub fn message(&self) -> Option<&str>

Returns the message.

pub fn request_id(&self) -> Uuid

Returns the request ID.

pub fn trace_id(&self) -> Uuid

Returns the trace ID.

pub fn content_type(&self) -> &str

Returns the content type.

pub fn headers(&self) -> &[(SharedString, String)]

Returns the custom headers.

pub fn trace_context(&self) -> (String, String)

Returns the trace context in the form (traceparent, tracestate).

pub fn server_timing(&self) -> String

Returns the server timing.

pub fn read_bytes(&mut self) -> Result<Bytes, Error>

Reads the response into a byte buffer.

pub fn response_time(&self) -> Duration

Gets the response time.

Note

It should only be called when the response will finish.

pub fn send_file(&mut self, file: NamedFile)

Sends a file to the client.

pub fn finalize(self) -> impl Iterator<Item = (SharedString, String)>

Consumes self and returns the custom headers.

Trait Implementations§

impl<S: Clone + ResponseCode> Clone for Response<S>
where S::ErrorCode: Clone, S::BusinessCode: Clone,

fn clone(&self) -> Response<S>

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<S: Debug + ResponseCode> Debug for Response<S>
where S::ErrorCode: Debug, S::BusinessCode: Debug,

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

Formats the value using the given formatter. Read more

impl<S: ResponseCode> Default for Response<S>

fn default() -> Self

Returns the “default value” for a type. Read more

impl From<Rejection> for Response<StatusCode>

fn from(rejection: Rejection) -> Self

Converts to this type from the input type.

impl<S: ResponseCode> From<Response<S>> for FullResponse

fn from(response: Response<S>) -> Self

Converts to this type from the input type.

impl<S: ResponseCode> From<Validation> for Response<S>

fn from(validation: Validation) -> Self

Converts to this type from the input type.

impl<S: ResponseCode> Serialize for Response<S>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl<S> RefUnwindSafe for Response<S>
where S: RefUnwindSafe, <S as ResponseCode>::BusinessCode: RefUnwindSafe, <S as ResponseCode>::ErrorCode: RefUnwindSafe,

impl<S> Send for Response<S>
where S: Send, <S as ResponseCode>::BusinessCode: Send, <S as ResponseCode>::ErrorCode: Send,

impl<S> Sync for Response<S>
where S: Sync, <S as ResponseCode>::BusinessCode: Sync, <S as ResponseCode>::ErrorCode: Sync,

impl<S> Unpin for Response<S>
where S: Unpin, <S as ResponseCode>::BusinessCode: Unpin, <S as ResponseCode>::ErrorCode: Unpin,

impl<S> UnwindSafe for Response<S>
where S: UnwindSafe, <S as ResponseCode>::BusinessCode: UnwindSafe, <S as ResponseCode>::ErrorCode: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<Choices> CoproductSubsetter<CNil, HNil> for Choices

type Remainder = Choices

fn subset( self ) -> Result<CNil, <Choices as CoproductSubsetter<CNil, HNil>>::Remainder>

Extract a subset of the possible types in a coproduct (or get the remaining possibilities) Read more

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

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, U, I> LiftInto<U, I> for T
where U: LiftFrom<T, I>,

fn lift_into(self) -> U

Performs the indexed conversion.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<Source> Sculptor<HNil, HNil> for Source

type Remainder = Source

fn sculpt(self) -> (HNil, <Source as Sculptor<HNil, HNil>>::Remainder)

Consumes the current HList and returns an HList with the requested shape. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<U, >::Error>> + 'async_trait>>
where T: 'async_trait,

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more