Struct rdftk_iri::Authority

pub struct Authority { /* fields omitted */ }

Provides the Authority component of an IRI comprising host, user information, and port sub-components. All but the host sub-components are optional.

1. The required host component is either a domain name, or IP address in IPV4 or IPV6 format.
2. The optional user information component consists of a required user name and optional password.
3. The optional port is simply an unsigned integer.

Example

use rdftk_iri::authority::{Authority, Host, Port};
use std::str::FromStr;

let http_authority = Authority::new_with_port(
        Host::from_str("www.example.com").unwrap(),
        Port::http()
    );

assert!(http_authority.has_port());
assert!(!http_authority.has_user_info());

Implementations

impl Authority

pub fn new(host: Host) -> Self

Construct a new Authority instance with only the specified Host value. Note that the host is required, other sub-components are optional.

pub fn new_with_port(host: Host, port: Port) -> Self

Construct a new Authority instance with only the required Host value and the optional Port value.

pub fn new_with_user_info(host: Host, user_info: UserInfo) -> Self

Construct a new Authority instance with only the required Host value and the optional UserInfo value.

pub fn new_with_port_and_user_info(
    host: Host,
    port: Port,
    user_info: UserInfo
) -> Self

Construct a new Authority instance with only the required Host value, the optional Port value, and optional UserInfo value.

pub fn host(&self) -> &Host

Return the current host value.

pub fn has_port(&self) -> bool

Return true if this authority has a port value, else false.

pub fn port(&self) -> &Option<Port>

Return the current port value, if present.

pub fn user_info(&self) -> &Option<UserInfo>

Return the current user info value, if present.

pub fn has_user_info(&self) -> bool

Return true if this authority has a user info value, else false.

pub fn set_host(&mut self, host: Host)

Set a new value for host.

pub fn set_port(&mut self, port: Port)

Set a new value for port.

pub fn unset_port(&mut self)

Set the value for port to None.

pub fn set_user_info(&mut self, user_info: UserInfo)

Set a new value for user info.

pub fn unset_user_info(&mut self)

Set the value for user info to None.

Trait Implementations

impl Clone for Authority

fn clone(&self) -> Authority

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Authority

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

Formats the value using the given formatter.

impl Display for Authority

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

Formats the value using the given formatter.

impl FromStr for Authority

type Err = IriError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Authority

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, 

Feeds a slice of this type into the given Hasher.

impl Normalize for Authority

fn normalize(self) -> IriResult<Self>

Return a normalized version of self. The default for normalization is to do nothing and return self unchanged.

impl Ord for Authority

fn cmp(&self, other: &Authority) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Authority> for Authority

fn eq(&self, other: &Authority) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Authority) -> bool

This method tests for !=.

impl PartialOrd<Authority> for Authority

fn partial_cmp(&self, other: &Authority) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PercentEncoding for Authority

fn encode(&self, for_uri: bool) -> Self where
    Self: Sized, 

Construct a new value that has been percent encoded. If for_uri is true this method will also encode all non-ascii characters as a sequence of UTF-8 octets in percent encoded form.

impl ValidateStr for Authority

fn is_valid(s: &str) -> bool

Return true if the string is a valid representation of Self, else false.

impl Eq for Authority

impl StructuralEq for Authority

impl StructuralPartialEq for Authority