Struct ResponseData

Source

pub struct ResponseData {
    pub status_code: u16,
    pub headers: HashMap<String, String>,
    pub body: Vec<u8>,
    pub content_type: String,
    pub metadata: HashMap<String, Value>,
    pub cache_control: Option<String>,
    pub custom: HashMap<String, Value>,
}

Expand description

Response data structure

Fields§

§status_code: u16

HTTP status code

§headers: HashMap<String, String>

Response headers

§body: Vec<u8>

Response body

§content_type: String

Content type

§metadata: HashMap<String, Value>

Response metadata

§cache_control: Option<String>

Cache control directives

§custom: HashMap<String, Value>

Custom response data

Implementations§

Source §

impl ResponseData

Source

pub fn new( status_code: u16, content_type: String, body: Vec<u8>, ) -> ResponseData

Create a new response

Source

pub fn json<T>(status_code: u16, data: &T) -> Result<ResponseData, PluginError>
where T: Serialize,

Create JSON response

Source

pub fn text<S>(status_code: u16, text: S) -> ResponseData
where S: Into<String>,

Create text response

Source

pub fn html<S>(status_code: u16, html: S) -> ResponseData
where S: Into<String>,

Create HTML response

Source

pub fn xml<S>(status_code: u16, xml: S) -> ResponseData
where S: Into<String>,

Create XML response

Source

pub fn with_header<S>(self, key: S, value: S) -> ResponseData
where S: Into<String>,

Add header

Source

pub fn with_headers(self, headers: HashMap<String, String>) -> ResponseData

Add multiple headers

Source

pub fn with_metadata<S>(self, key: S, value: Value) -> ResponseData
where S: Into<String>,

Add metadata

Source

pub fn with_cache_control<S>(self, cache_control: S) -> ResponseData
where S: Into<String>,

Set cache control

Source

pub fn with_custom<S>(self, key: S, value: Value) -> ResponseData
where S: Into<String>,

Add custom data

Source

pub fn to_axum_response(self) -> Result<Response<Body>, PluginError>

Convert to axum response

Source

pub fn body_as_string(&self) -> Option<String>

Get body as string (if valid UTF-8)

Source

pub fn body_as_json(&self) -> Option<Value>

Get body as JSON value

Trait Implementations§

Source §

impl Clone for ResponseData

Source §

fn clone(&self) -> ResponseData

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ResponseData

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for ResponseData

Source §

fn deserialize<D>( deserializer: D, ) -> Result<ResponseData, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Serialize for ResponseData

Source §

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ResponseData

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

Source §

impl<T> GetSetFdFlags for T

Source §

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.

Source §

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more

Source §

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more

Source §

impl<T> Instrument for T

Source §

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

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

Source §

fn in_current_span(self) -> Instrumented<Self>

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

Source §

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

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> Pointable for T

Source §

const ALIGN: usize

The alignment of pointer.

Source §

type Init = T

The type for initializers.

Source §

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

Initializes a with the given initializer. Read more

Source §

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

Dereferences the given pointer. Read more

Source §

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

Mutably dereferences the given pointer. Read more

Source §

unsafe fn drop(ptr: usize)

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

Source §

impl<T> Pointee for T

Source §

type Pointer = u32

Source §

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source §

impl<T> Same for T

Source §

type Output = T

Should always be Self

Source §

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

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

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

Source §

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

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

Source §

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

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

fn vzip(self) -> V

Source §

impl<T> WithSubscriber for T

Source §

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

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Source §

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source §

impl<T> ErasedDestructor for T
where T: 'static,

Source §

Struct ResponseData Copy item path

Fields§

Implementations§

impl ResponseData

pub fn new( status_code: u16, content_type: String, body: Vec<u8>, ) -> ResponseData

pub fn json<T>(status_code: u16, data: &T) -> Result<ResponseData, PluginError>where T: Serialize,

pub fn text<S>(status_code: u16, text: S) -> ResponseDatawhere S: Into<String>,

pub fn html<S>(status_code: u16, html: S) -> ResponseDatawhere S: Into<String>,

pub fn xml<S>(status_code: u16, xml: S) -> ResponseDatawhere S: Into<String>,

pub fn with_header<S>(self, key: S, value: S) -> ResponseDatawhere S: Into<String>,

pub fn with_headers(self, headers: HashMap<String, String>) -> ResponseData

pub fn with_metadata<S>(self, key: S, value: Value) -> ResponseDatawhere S: Into<String>,

pub fn with_cache_control<S>(self, cache_control: S) -> ResponseDatawhere S: Into<String>,

pub fn with_custom<S>(self, key: S, value: Value) -> ResponseDatawhere S: Into<String>,

pub fn to_axum_response(self) -> Result<Response<Body>, PluginError>

pub fn body_as_string(&self) -> Option<String>

pub fn body_as_json(&self) -> Option<Value>

Trait Implementations§

impl Clone for ResponseData

fn clone(&self) -> ResponseData

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

impl Debug for ResponseData

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

impl<'de> Deserialize<'de> for ResponseData

fn deserialize<__D>( __deserializer: __D, ) -> Result<ResponseData, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

impl Serialize for ResponseData

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Auto Trait Implementations§

impl Freeze for ResponseData

impl RefUnwindSafe for ResponseData

impl Send for ResponseData

impl Sync for ResponseData

impl Unpin for ResponseData

impl UnwindSafe for ResponseData

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromRef<T> for Twhere T: Clone,

fn from_ref(input: &T) -> T

impl<T> GetSetFdFlags for T

fn get_fd_flags(&self) -> Result<FdFlags, Error>where T: AsFilelike,

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>where T: AsFilelike,

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>where T: AsFilelike,

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Pointee for T

type Pointer = u32

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

Struct ResponseData

pub fn json<T>(status_code: u16, data: &T) -> Result<ResponseData, PluginError>
where T: Serialize,

pub fn text<S>(status_code: u16, text: S) -> ResponseData
where S: Into<String>,

pub fn html<S>(status_code: u16, html: S) -> ResponseData
where S: Into<String>,

pub fn xml<S>(status_code: u16, xml: S) -> ResponseData
where S: Into<String>,

pub fn with_header<S>(self, key: S, value: S) -> ResponseData
where S: Into<String>,

pub fn with_metadata<S>(self, key: S, value: Value) -> ResponseData
where S: Into<String>,

pub fn with_cache_control<S>(self, cache_control: S) -> ResponseData
where S: Into<String>,

pub fn with_custom<S>(self, key: S, value: Value) -> ResponseData
where S: Into<String>,

fn deserialize<D>( deserializer: D, ) -> Result<ResponseData, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

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

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

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

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

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

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

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

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

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

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,