Struct Link 

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

A hypermedia link following HAL specification

Links provide navigation between related resources.

Example

use rustapi_core::hateoas::Link;

let link = Link::new("/users/123")
    .title("User details")
    .set_templated(false);

Fields

href: String

The URI of the linked resource

templated: Option<bool>

Whether the href is a URI template

title: Option<String>

Human-readable title for the link

media_type: Option<String>

Media type hint for the linked resource

deprecation: Option<String>

URI indicating the link is deprecated

name: Option<String>

Name for differentiating links with the same relation

profile: Option<String>

URI of a profile document

hreflang: Option<String>

Content-Language of the linked resource

Implementations

impl Link

pub fn new(href: impl Into<String>) -> Link

Create a new link with the given href

pub fn templated(href: impl Into<String>) -> Link

Create a templated link (URI template)

Example

use rustapi_core::hateoas::Link;

let link = Link::templated("/users/{id}");

pub fn set_templated(self, templated: bool) -> Link

Set whether this link is templated

pub fn title(self, title: impl Into<String>) -> Link

Set the title

pub fn media_type(self, media_type: impl Into<String>) -> Link

Set the media type

pub fn deprecation(self, deprecation_url: impl Into<String>) -> Link

Mark as deprecated

pub fn name(self, name: impl Into<String>) -> Link

Set the name

pub fn profile(self, profile: impl Into<String>) -> Link

Set the profile

pub fn hreflang(self, hreflang: impl Into<String>) -> Link

Set the hreflang

Trait Implementations

impl Clone for Link

fn clone(&self) -> Link

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Link> for LinkOrArray

fn from(link: Link) -> LinkOrArray

Converts to this type from the input type.

impl PartialEq for Link

fn eq(&self, other: &Link) -> 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 Serialize for Link

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Link