Struct Identifier

pub struct Identifier {
    pub id: String,
    pub kind: Key,
    pub meta: Map,
    /* private fields */
}

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.

Implementations

impl Identifier

pub 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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Identifier

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

Converts to this type from the input type.

impl From<Identifier> for Relationship

fn from(value: Identifier) -> Self

Converts to this type from the input type.

impl From<Object> for Identifier

fn from(object: Object) -> Self

Converts to this type from the input type.

impl FromIterator<Identifier> for Relationship

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Identifier>,

Creates a value from an iterator.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Identifier> for Object

fn eq(&self, rhs: &Identifier) -> 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 PartialEq<Object> for Identifier

fn eq(&self, rhs: &Object) -> 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 PartialEq for Identifier

fn eq(&self, rhs: &Identifier) -> 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<'a, T: Resource> Render<Identifier> for &'a [T]

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

Attempts to render the given type as a document.

impl<'a, T: Resource> Render<Identifier> for &'a T

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

Attempts to render the given type as a document.

impl Render<Identifier> for Identifier

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

Attempts to render the given type as a document.

impl Render<Identifier> for Object

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

Attempts to render the given type as a document.

impl Render<Identifier> for Vec<Identifier>

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

Attempts to render the given type as a document.

impl Render<Identifier> for Vec<Object>

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

Attempts to render the given type as a document.

impl Serialize for Identifier

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Identifier

impl PrimaryData for Identifier