Struct df_st_api::api_objects::ApiItem

pub struct ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample,  {
    pub type_: String,
    pub links: ApiItemLinks,
    pub data: D,
    pub base_url: String,
}

A Wrapper for an ApiObject that includes additional metadata.

Fields

type_: String

A unique string identifier for this type.

links: ApiItemLinks

Links the various related items.

data: D

The included data item.

base_url: String

Server base url. Not included in response.

Implementations

impl<D> ApiItem<D> where
    D: ApiObject + Default + Serialize + SchemaExample, 

pub fn new(server_info: &State<'_, ServerInfo>) -> Self

pub fn wrap(&mut self, item: D)

Store the data in the object and construct links.

pub fn wrap_new(item: D, base_url: &str) -> ApiItem<D>

Create and wrap the item. This is the same as doing:

let api_item = ApiItem::wrap_new(result_item, &server_info.base_url);
// same as:
let api_item = ApiItem::new(server_info);
api_item.wrap(result_item);

Trait Implementations

impl<D: Clone> Clone for ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample, 

fn clone(&self) -> ApiItem<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample, 

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

Formats the value using the given formatter.

impl<D: Default> Default for ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample, 

fn default() -> ApiItem<D>

Returns the "default value" for a type.

impl<'de, D> Deserialize<'de> for ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample,
    D: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<D: JsonSchema> JsonSchema for ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample, 

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<D> SchemaExample for ApiItem<D> where
    D: SchemaExample + Serialize + ApiObject, 

fn example() -> Self

impl<D> Serialize for ApiItem<D> where
    D: ApiObject + Serialize + SchemaExample,
    D: Serialize, 

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

Serialize this value into the given Serde serializer.