Struct json_api::doc::NewObject

pub struct NewObject {
    pub attributes: Map,
    pub id: Option<String>,
    pub kind: Key,
    pub links: Map<Key, Link>,
    pub meta: Map,
    pub relationships: Map<Key, Relationship>,
    // some fields omitted
}

A resource that does not already exist. Commonly found in the document of a POST request.

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

Fields

attributes: Map

Contains some of the object's data. If this value of this field is empty, it will not be serialized. For more information, check out the attributes section of the JSON API specification.

id: Option<String>

An optional string that contains a unique identfier for this resource type (kind). A Some value here should be interpreted as client-generated id. For more information, check out the identification section of the JSON API specification.

kind: Key

Describes resources that share common attributes and relationships. This field is derived from the type field if the object is deserialized. For more information, check out the identification section of the JSON API specification.

links: Map<Key, Link>

Contains relevant links. If this value of this field is empty, it will not be serialized. For more information, check out the links section of the JSON API specification.

meta: Map

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

relationships: Map<Key, Relationship>

Describes relationships between this object and other resource objects. If this value of this field is empty, it will not be serialized. For more information, check out the relationships section of the JSON API specification.

Methods

impl NewObject

fn new(kind: Key) -> Self

Returns a new NewObject.

Example

use json_api::doc::NewObject;
let mut obj = NewObject::new("users".parse()?);

Trait Implementations

impl Clone for NewObject

fn clone(&self) -> NewObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NewObject

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PrimaryData for NewObject

fn flatten(self, _: &Set<Object>) -> Value

impl Render<NewObject> for NewObject

fn render(self, _: Option<&Query>) -> Result<Document<NewObject>, Error>

Attempts to render the given type as a document.