Struct LinkData

pub struct LinkData<'a> {
    pub uri_ref: URIReference<'a>,
    pub description: Option<Description<'a>>,
    pub properties: Option<HashMap<Cow<'a, str>, Cow<'a, str>>>,
}

Represents data for a link to some content, described through a combination of a URI reference and some arbitrary description

Fields

uri_ref: URIReference<'a>

description: Option<Description<'a>>

properties: Option<HashMap<Cow<'a, str>, Cow<'a, str>>>

Implementations

impl<'a> LinkData<'a>

pub fn new( uri_ref: URIReference<'a>, description: Option<Description<'a>>, properties: Option<HashMap<Cow<'a, str>, Cow<'a, str>>>, ) -> LinkData<'a>

impl LinkData<'_>

pub fn to_borrowed(&self) -> LinkData<'_>

pub fn into_owned(self) -> LinkData<'static>

impl<'a> LinkData<'a>

pub fn encode_uri<U>(uri: U) -> String

where U: AsRef<[u8]>,

Allocates a new string with specific URI characters encoded

pub fn decode_uri<U>(uri: U) -> String

where U: AsRef<[u8]>,

Allocates a new string with percent-encoded characters decoded

pub fn is_local_anchor(&self) -> bool

Whether or not the link is representing an anchor to the current page

pub fn is_path_dir(&self) -> bool

Checks if the link’s path is to a directory without actually evaluating in the filesystem. Only checks if the path appears as that of a directory

pub fn is_local(&self) -> bool

Whether or not the associated URI is local to the current system

pub fn is_remote(&self) -> bool

Whether or not the associated URI is targeting a remote system

pub fn to_path_buf(&self) -> PathBuf

Produces a PathBuf from the path of the link’s uri, using the system’s separator as the start if absolute

pub fn fragment_str(&self) -> Option<&str>

Returns a reference to the fragment portion of the link’s uri (after the first # sign)

pub fn has_anchor(&self) -> bool

Returns true if the link’s uri contains an anchor (#something)

pub fn to_anchor(&self) -> Option<Anchor<'_>>

Produces an Anchor referencing the fragment portion of the link

pub fn scheme(&self) -> Option<&Scheme<'_>>

Returns reference to the scheme of the link’s uri if it exists

Trait Implementations

impl<'a> Clone for LinkData<'a>

fn clone(&self) -> LinkData<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LinkData<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for LinkData<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Display for LinkData<'a>

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

Formats the value using the given formatter.

impl<'a> From<LinkData<'a>> for Description<'a>

fn from(link_data: LinkData<'a>) -> Description<'a>

Converts to this type from the input type.

impl<'a> From<URIReference<'a>> for LinkData<'a>

fn from(uri_ref: URIReference<'a>) -> LinkData<'a>

Converts to this type from the input type.

impl<'a> Hash for LinkData<'a>

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<'a> PartialEq for LinkData<'a>

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

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<'a> StrictEq for LinkData<'a>

fn strict_eq(&self, other: &LinkData<'a>) -> bool

Same as PartialEq

fn strict_ne(&self, other: &Rhs) -> bool

impl<'a> TryFrom<&'a str> for LinkData<'a>

fn try_from( s: &'a str, ) -> Result<LinkData<'a>, <LinkData<'a> as TryFrom<&'a str>>::Error>

Converts str into a link by parsing the str as a uriparse::URIReference

type Error = URIReferenceError

The type returned in the event of a conversion error.

impl TryFrom<String> for LinkData<'static>

fn try_from( s: String, ) -> Result<LinkData<'static>, <LinkData<'static> as TryFrom<String>>::Error>

Converts String into a link by parsing the String as a uriparse::URIReference

type Error = URIReferenceError

The type returned in the event of a conversion error.

impl<'a> Eq for LinkData<'a>

impl<'a> StructuralPartialEq for LinkData<'a>