Enum LinkLocality

#[repr(u8)]
pub enum LinkLocality {
    SelfLink = 0,
    InLink = 1,
    OutLink = 2,
}

Describes the link destinations relation to the page it is on.

A site is by default equivalent to a hostname.

Exceptions:

• A site that hosts different sites on subpaths, protocols or ports
• Multiple hosts might be considered hostig the same Site

Variants

SelfLink = 0

Self-Links link inside the document and only change the fragment

InLink = 1

In-Links link to a different document on the same site

OutLink = 2

Out-Links leave the site they are on. It is a safe fallback and returned by Default::default().

Implementations

impl LinkLocality

pub fn new(link_url: &Url, document_url: &Url) -> Self

A classifier that implements some sane defaults.

It is intented to produce okay results without any configuration.

Rules:

• link_url without host => OutLink
• Different host => OutLink
• Different port => OutLink
• Different scheme after removing trailing ‘s’ => Outlink
• Different path => InLink
• Different query => InLink
• Else => SelfLink

Wrapping this function to produce configurable and more sophisticated behavior is encouraged.

pub fn from_u8_or_outlink(id: u8) -> Self

A guaranteed to succeed number to enum converter, that converts all unknown numbers to outlinks

Trait Implementations

impl AsInteger for LinkLocality

fn as_criterium_i64(&self) -> i64

Converts whatever implements this trait into an i64 for comparing against some other number using a NumberCriterium.

impl Clone for LinkLocality

fn clone(&self) -> LinkLocality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkLocality

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

Formats the value using the given formatter.

impl Default for LinkLocality

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LinkLocality

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LinkLocality

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

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 LinkLocality

impl StructuralPartialEq for LinkLocality