Struct Links 

pub struct Links(/* private fields */);

An ordered collection of Link values.

Preserves insertion order; duplicate rel values are allowed (some APIs return multiple "related" links). Use Links::find to look up the first link with a given rel.

Implementations

impl Links

pub fn new() -> Self

Create an empty Links collection.

use api_bones::links::Links;

let links = Links::new();
assert!(links.is_empty());

pub fn push(self, link: Link) -> Self

Append a Link and return self (builder-style).

use api_bones::links::{Link, Links};

let links = Links::new()
    .push(Link::self_link("/a"))
    .push(Link::next("/b"));
assert_eq!(links.len(), 2);

pub fn find(&self, rel: &str) -> Option<&Link>

Return the first Link whose rel matches rel, if any.

use api_bones::links::{Link, Links};

let links = Links::new()
    .push(Link::self_link("/a"))
    .push(Link::next("/b"));
assert_eq!(links.find("next").unwrap().href, "/b");
assert!(links.find("prev").is_none());

pub fn iter(&self) -> impl Iterator<Item = &Link>

Iterate over all contained links.

pub fn len(&self) -> usize

Return the number of links in the collection.

pub fn is_empty(&self) -> bool

Return true if the collection contains no links.

Trait Implementations

impl Clone for Links

fn clone(&self) -> Links

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Links

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

Formats the value using the given formatter.

impl Default for Links

fn default() -> Links

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Links

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Vec<Link>> for Links

fn from(v: Vec<Link>) -> Self

Converts to this type from the input type.

impl IntoIterator for Links

type Item = Link

The type of the elements being iterated over.

type IntoIter = <Vec<Link> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Links

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Links

impl StructuralPartialEq for Links