api_response::prelude

Struct SuccessResponse

Source
#[non_exhaustive]
pub struct SuccessResponse<Data, Meta> { pub data: Data, pub meta: Option<Meta>, }
Expand description

Struct to represent a successful response

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§data: Data§meta: Option<Meta>

Implementations§

Source§

impl<Data, Meta> SuccessResponse<Data, Meta>

Source

pub const fn new(data: Data, meta: Meta) -> Self

Source

pub const fn from_data(data: Data) -> Self

Source

pub fn with_meta(self, meta: Meta) -> Self

Source

pub fn set_meta(&mut self, meta: Meta) -> &mut Self

Trait Implementations§

Source§

impl<Data: Debug, Meta: Debug> Debug for SuccessResponse<Data, Meta>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, Data, Meta> Deserialize<'de> for SuccessResponse<Data, Meta>
where Data: Deserialize<'de>, Meta: Deserialize<'de>,

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<Data, Meta> From<SuccessResponse<Data, Meta>> for ApiResponse<Data, Meta>

Source§

fn from(value: SuccessResponse<Data, Meta>) -> Self

Converts to this type from the input type.
Source§

impl<Data, Meta> From<SuccessResponse<Data, Meta>> for Result<Data, ApiError>

Source§

fn from(success_response: SuccessResponse<Data, Meta>) -> Self

Converts to this type from the input type.
Source§

impl<Data, Meta> From<SuccessResponse<Data, Meta>> for ApiResult<Data, Meta>

Source§

fn from(success_response: SuccessResponse<Data, Meta>) -> Self

Converts to this type from the input type.
Source§

impl<Data, Meta> Serialize for SuccessResponse<Data, Meta>
where Data: Serialize, Meta: Serialize,

Source§

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<Data, Meta> Freeze for SuccessResponse<Data, Meta>
where Data: Freeze, Meta: Freeze,

§

impl<Data, Meta> RefUnwindSafe for SuccessResponse<Data, Meta>
where Data: RefUnwindSafe, Meta: RefUnwindSafe,

§

impl<Data, Meta> Send for SuccessResponse<Data, Meta>
where Data: Send, Meta: Send,

§

impl<Data, Meta> Sync for SuccessResponse<Data, Meta>
where Data: Sync, Meta: Sync,

§

impl<Data, Meta> Unpin for SuccessResponse<Data, Meta>
where Data: Unpin, Meta: Unpin,

§

impl<Data, Meta> UnwindSafe for SuccessResponse<Data, Meta>
where Data: UnwindSafe, Meta: UnwindSafe,

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<Data> ApiSuccessResponse for Data

Source§

fn api_response<Meta>(self, meta: Option<Meta>) -> ApiResponse<Self, Meta>

Source§

fn api_response_without_meta<Meta>(self) -> ApiResponse<Self, Meta>

Source§

fn api_response_with_meta<Meta>(self, meta: Meta) -> ApiResponse<Self, Meta>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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