Struct JsonApi

pub struct JsonApi {
    pub meta: Map,
    pub version: Version,
    /* private fields */
}

Information about this implementation of the specification.

For more information, check out the JSON API object section of the JSON API specification.

Fields

meta: Map

Non-standard meta information. If this value of this field is empty, it will not be included if the object is serialized. For more information, check out the meta information section of the JSON API specification.

version: Version

The latest version of the JSON API specification that is supported by this implementation. Defaults to the latest available version.

Implementations

impl JsonApi

pub fn new(version: Version) -> Self

Returns a new JsonApi with the specified version.

Example

use json_api::doc::{JsonApi, Version};
assert_eq!(JsonApi::default(), JsonApi::new(Version::V1));

Trait Implementations

impl Clone for JsonApi

fn clone(&self) -> JsonApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonApi

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

Formats the value using the given formatter.

impl Default for JsonApi

fn default() -> JsonApi

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonApi

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsonApi

fn eq(&self, other: &JsonApi) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JsonApi

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JsonApi