Enum japi::Link

pub enum Link {
    Url(String),
    Object {
        href: Option<String>,
        meta: Option<Meta>,
    },
}

A link object

Enum represents every valid configuration but in practice you should probably either use Links::Url for links with just a URL or Links::Object if you need to include a meta object

See the JSON:API docs for more information

Variants

Url(String)

Object

Fields of Object

href: Option<String>meta: Option<Meta>

Methods

impl Link

pub fn href<'a>(&'a self) -> Option<&'a str>

Grabs the url of the link regardless of its variant

pub fn new(url: String, meta: Option<Meta>) -> Self

If meta is None will construct Link::Url instead of Link::Object

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Link

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

Formats the value using the given formatter.

impl Default for Link

Defaults to Link::Object with all fields None

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Link

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Link> for Link

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

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

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

This method tests for !=.

impl Serialize for Link

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 Link