Struct JrdLink 

#[non_exhaustive]
pub struct JrdLink {
    pub rel: String,
    pub media_type: Option<String>,
    pub href: Option<Url>,
    pub titles: BTreeMap<String, String>,
    pub properties: BTreeMap<String, Option<String>>,
    pub template: Option<String>,
}

A link entry inside a Jrd.

Per RFC 7033 §4.4.4, the href and template members are mutually exclusive: only one MUST be present in a given link. This invariant is checked at runtime by JrdLink::validate and asserted by JrdLinkBuilder in debug builds.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rel: String

Link relation (IANA registered name or URI).

media_type: Option<String>

Media type of the resource referenced by href.

href: Option<Url>

URI of the related resource.

titles: BTreeMap<String, String>

Localised titles keyed by BCP-47 language tag.

properties: BTreeMap<String, Option<String>>

Link-specific properties.

template: Option<String>

URI template for links that synthesise a URI from parameters.

Implementations

impl JrdLink

pub fn builder(rel: impl Into<String>) -> JrdLinkBuilder

Returns a new JrdLinkBuilder.

pub const fn validate(&self) -> Result<(), &'static str>

Checks that this link satisfies the RFC 7033 §4.4.4 invariants.

Currently enforces mutual exclusion between href and template.

Errors

Returns Err if both href and template are set.

Trait Implementations

impl Clone for JrdLink

fn clone(&self) -> JrdLink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JrdLink

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

Formats the value using the given formatter.

impl Default for JrdLink

fn default() -> JrdLink

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JrdLink

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for JrdLink

impl PartialEq for JrdLink

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

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 JrdLink