Struct SafeUrl

pub struct SafeUrl(Url);

Wrapper for Url that only prints the scheme, domain, port and path portion of a Url in its Display implementation.

This is useful to hide private information like user names and passwords in logs or UIs.

The output is not fully RFC1738 conformant but good enough for our current purposes.

Tuple Fields

0: Url

Implementations

impl SafeUrl

pub fn parse(url_str: &str) -> Result<Self, ParseError>

pub fn to_unsafe(self) -> Url

Warning: This removes the safety.

pub fn set_username(&mut self, username: &str) -> Result<(), ()>

pub fn set_password(&mut self, password: Option<&str>) -> Result<(), ()>

pub fn without_auth(&self) -> Result<Self, SafeUrlError>

pub fn host(&self) -> Option<Host<&str>>

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

pub fn scheme(&self) -> &str

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

pub fn port_or_known_default(&self) -> Option<u16>

pub fn with_port_or_known_default(&self) -> Self

self but with port explicitly set, if known from url

pub fn path(&self) -> &str

pub fn as_str(&self) -> &str

Warning: This will expose username & password if present.

pub fn username(&self) -> &str

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

pub fn join(&self, input: &str) -> Result<Self, ParseError>

pub fn is_onion_address(&self) -> bool

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

pub fn set_fragment(&mut self, arg: Option<&str>)

Trait Implementations

impl Clone for SafeUrl

fn clone(&self) -> SafeUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SafeUrl

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

Formats the value using the given formatter.

impl Decodable for SafeUrl

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for SafeUrl

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SafeUrl

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

Formats the value using the given formatter.

impl Encodable for SafeUrl

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, H::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl FromStr for SafeUrl

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, ParseError>

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

impl Hash for SafeUrl

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 Ord for SafeUrl

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SafeUrl

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for SafeUrl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Url> for SafeUrl

Only ease conversions from unsafe into safe version. We want to protect leakage of sensitive credentials unless code explicitly calls to_unsafe().

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for SafeUrl

impl StructuralPartialEq for SafeUrl