Struct json_api::doc::Relationship

pub struct Relationship {
    pub data: Data<Identifier>,
    pub links: Map<Key, Link>,
    pub meta: Map,
    // some fields omitted
}

Represents a resource's relationship to another.

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

Fields

data: Data<Identifier>

Contains resource linkage. For more information, checkout the resource linkage 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.

Methods

impl Relationship

fn new(data: Data<Identifier>) -> Self

Returns a new Relationship.

Example

use json_api::doc::{Data, Identifier, Relationship};

let ident = Identifier::new("users".parse()?, "1".to_owned());
let data = Data::Member(Box::new(Some(ident)));
let mut relationship = Relationship::new(data);

Trait Implementations

impl Clone for Relationship

fn clone(&self) -> Relationship

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Relationship

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

Formats the value using the given formatter.

impl PartialEq for Relationship

fn eq(&self, __arg_0: &Relationship) -> bool

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

fn ne(&self, __arg_0: &Relationship) -> bool

This method tests for !=.

impl From<Option<Identifier>> for Relationship

fn from(value: Option<Identifier>) -> Self

Performs the conversion.

impl From<Vec<Identifier>> for Relationship

fn from(value: Vec<Identifier>) -> Self

Performs the conversion.

impl From<Identifier> for Relationship

fn from(value: Identifier) -> Self

Performs the conversion.

impl FromIterator<Identifier> for Relationship

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = Identifier>, 

Creates a value from an iterator.