Struct Link 

pub struct Link {
    pub rel: String,
    pub href: String,
    pub method: Option<String>,
}

A single HATEOAS link with a relation type, target URL, and optional HTTP method hint.

The rel field follows the IANA link relations registry where applicable (e.g. "self", "next", "prev").

Fields

rel: String

The link relation type (e.g. "self", "next", "related").

href: String

The target URL.

method: Option<String>

Optional HTTP method hint (e.g. "GET", "POST").

Implementations

impl Link

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

Create a new Link with the given relation and href.

use api_bones::links::Link;

let link = Link::new("related", "/other");
assert_eq!(link.rel, "related");
assert_eq!(link.href, "/other");
assert!(link.method.is_none());

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

Set the optional HTTP method hint (builder-style).

use api_bones::links::Link;

let link = Link::new("create", "/items").method("POST");
assert_eq!(link.method.as_deref(), Some("POST"));

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

Construct a "self" link.

use api_bones::links::Link;

let link = Link::self_link("/resources/42");
assert_eq!(link.rel, "self");
assert_eq!(link.href, "/resources/42");

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

Construct a "next" link (next page in a paginated response).

use api_bones::links::Link;

let link = Link::next("/resources?page=2");
assert_eq!(link.rel, "next");
assert_eq!(link.href, "/resources?page=2");

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

Construct a "prev" link (previous page in a paginated response).

use api_bones::links::Link;

let link = Link::prev("/resources?page=1");
assert_eq!(link.rel, "prev");
assert_eq!(link.href, "/resources?page=1");

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

Construct a "related" link.

use api_bones::links::Link;

let link = Link::related("/users/42");
assert_eq!(link.rel, "related");
assert_eq!(link.href, "/users/42");

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

Construct a "first" link (first page of a paginated response).

use api_bones::links::Link;

let link = Link::first("/resources?page=1");
assert_eq!(link.rel, "first");
assert_eq!(link.href, "/resources?page=1");

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

Construct a "last" link (last page of a paginated response).

use api_bones::links::Link;

let link = Link::last("/resources?page=10");
assert_eq!(link.rel, "last");
assert_eq!(link.href, "/resources?page=10");

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 Hash for Link

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 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 Eq for Link

impl StructuralPartialEq for Link