Struct HostKey 

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

A type-safe representation of a hostname for rate limiting purposes.

This extracts and normalizes hostnames from URLs to ensure consistent rate limiting across requests to the same host (domain or IP address).

Examples

use lychee_lib::ratelimit::HostKey;
use url::Url;

let url = Url::parse("https://api.github.com/repos/user/repo").unwrap();
let host_key = HostKey::try_from(&url).unwrap();
assert_eq!(host_key.as_str(), "api.github.com");

Implementations

impl HostKey

pub fn as_str(&self) -> &str

Get the hostname as a string slice

pub fn into_string(self) -> String

Get the hostname as an owned String

Trait Implementations

impl Clone for HostKey

fn clone(&self) -> HostKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HostKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HostKey

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

Formats the value using the given formatter.

impl From<&str> for HostKey

fn from(host: &str) -> Self

Converts to this type from the input type.

impl From<String> for HostKey

fn from(host: String) -> Self

Converts to this type from the input type.

impl Hash for HostKey

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

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 HostKey

fn eq(&self, other: &HostKey) -> 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 TryFrom<&Uri> for HostKey

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(uri: &Uri) -> Result<Self>

Performs the conversion.

impl TryFrom<&Url> for HostKey

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(url: &Url) -> Result<Self>

Performs the conversion.

impl TryFrom<Url> for HostKey

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self>

Performs the conversion.

impl Eq for HostKey

impl StructuralPartialEq for HostKey