Struct json_api::doc::Identifier

pub struct Identifier {
    pub id: String,
    pub kind: Key,
    pub meta: Map,
    // some fields omitted
}

Identifies an individual resource. Commonly found in an object's relationships.

Identifiers share their equality and hashing behavior with Object. For more information, check out the resource identifier objects section of the JSON API specification.

Fields

id: String

A string that contains a unique identfier for this resource type (kind). 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 identifier is deserialized. For more information, check out the identification 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.

Methods

impl Identifier

fn new(kind: Key, id: String) -> Self

Returns a new Identifier.

Example

use json_api::doc::Identifier;
let mut ident = Identifier::new("users".parse()?, "1".to_owned());

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Eq for Identifier

impl From<Object> for Identifier

fn from(object: Object) -> Self

Performs the conversion.

impl<'a> From<&'a Object> for Identifier

fn from(object: &'a Object) -> Self

Performs the conversion.

impl Hash for Identifier

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq for Identifier

fn eq(&self, rhs: &Identifier) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Object> for Identifier

fn eq(&self, rhs: &Object) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Render<Identifier> for Identifier

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

Attempts to render the given type as a document.

impl PrimaryData for Identifier

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