Struct rustic_hal::link::HalLink

pub struct HalLink {
    pub href: String,
    pub templated: bool,
    pub media_type: Option<String>,
    pub deprecation: Option<String>,
    pub name: Option<String>,
    pub profile: Option<String>,
    pub title: Option<String>,
    pub hreflang: Option<String>,
}

A Link object for linking HAL Resources.

The link represents a related resource. If follows the HAL Draft Spec

Examples

use rustic_hal::HalLink;

let link = HalLink::new("http://sowewhere.com");

Fields

href: String

The "href" property is REQUIRED.

Its value is either a URI [RFC3986] or a URI Template [RFC6570].

If the value is a URI Template then the Link Object SHOULD have a "templated" attribute whose value is true.

templated: bool

The "templated" property is OPTIONAL.

Its value is boolean and SHOULD be true when the Link Object's "href" property is a URI Template.

Its value SHOULD be considered false if it is undefined or any other value than true.

media_type: Option<String>

The "type" property is OPTIONAL.

Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource.

deprecation: Option<String>

The "deprecation" property is OPTIONAL.

Its presence indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation.

A client SHOULD provide some notification (for example, by logging a warning message) whenever it traverses over a link that has this property. The notification SHOULD include the deprecation property's value so that a client manitainer can easily find information about the deprecation.

name: Option<String>

The "name" property is OPTIONAL.

Its value MAY be used as a secondary key for selecting Link Objects which share the same relation type.

profile: Option<String>

The "profile" property is OPTIONAL.

Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link]) of the target resource.

title: Option<String>

The "title" property is OPTIONAL.

Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988]).

hreflang: Option<String>

The "hreflang" property is OPTIONAL.

Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]).

Methods

impl HalLink

pub fn new<S>(href: S) -> HalLink where
    S: Into<String>, 

pub fn templated(self, templated: bool) -> Self

pub fn with_media_type(self, media_type: &str) -> Self

pub fn media_type(&self) -> Option<String>

pub fn with_deprecation(self, deprecation: &str) -> Self

pub fn deprecation(&self) -> Option<String>

pub fn with_name(self, name: &str) -> Self

pub fn name(&self) -> Option<String>

pub fn with_profile(self, profile: &str) -> Self

pub fn profile(&self) -> Option<String>

pub fn with_title(self, title: &str) -> Self

pub fn title(&self) -> Option<String>

pub fn with_hreflang(self, hreflang: &str) -> Self

pub fn hreflang(&self) -> Option<String>

Trait Implementations

impl PartialEq<HalLink> for HalLink

Two links are the same if their href is the same The rest is immaterial

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

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

#[must_use]

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

This method tests for !=.

impl Clone for HalLink

fn clone(&self) -> HalLink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> From<T> for HalLink where
    T: Into<String>, 

fn from(s: T) -> Self

Performs the conversion.

impl Debug for HalLink

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

Formats the value using the given formatter.

impl Serialize for HalLink

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for HalLink

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

Deserialize this value from the given Serde deserializer.