1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
/*!
# URL Prefix
This crate can be used to create URL prefix strings by inputting a protocol, a domain, a port number and a path without additional parsing.
## Why We Need This?
Sometimes our web applications are run on different protocols(HTTP/HTTPS) and domains. And it is boring to write some code like below to format a URL:
```rust,ignore
let mut url_prefix = String::new();
if is_https {
url_prefix.push_str("https://");
} else {
url_prefix.push_str("http://");
}
url_prefix.push_str(domain);
if is_https && port != 443 || !is_https && port != 80 {
url_prefix.push_str(":");
url_prefix.push_str(&port.to_string());
}
```
Instead, we can easily use this crate to create URL prefix strings. For examples,
```rust
let prefix = url_prefix::create_prefix(url_prefix::Protocol::HTTPS, "magiclen.org", None, None::<String>);
assert_eq!("https://magiclen.org", prefix);
```
```rust
let prefix = url_prefix::create_prefix(url_prefix::Protocol::HTTPS, "magiclen.org", Some(8100), Some("url-prefix"));
assert_eq!("https://magiclen.org:8100/url-prefix", prefix);
```
*/
#![no_std]
#[macro_use]
extern crate alloc;
use core::fmt::Write;
use alloc::string::String;
use cow_utils::CowUtils;
macro_rules! impl_protocol {
( $($protocol:ident, $name:expr, $port:expr); * $(;)* ) => {
/// A set of protocols for URLs.
#[allow(clippy::upper_case_acronyms)]
#[derive(Debug, Clone)]
pub enum Protocol {
$(
$protocol,
)+
/// Your own custom protocol created by giving a name and a default port number.
Custom(String, u16)
}
impl Protocol{
pub fn get_default_from_str<S: AsRef<str>>(s: S) -> Option<Self>{
let lowered_case = s.as_ref().cow_to_lowercase();
match lowered_case.as_ref() {
$(
$name => Some(Protocol::$protocol),
)+
_ => None
}
}
pub fn get_default_port(&self) -> u16 {
match self {
$(
Protocol::$protocol => $port,
)+
Protocol::Custom(_, port) => *port
}
}
pub fn get_name(&self) -> &str {
match self {
$(
Protocol::$protocol => $name,
)+
Protocol::Custom(name, _) => &name
}
}
}
};
}
impl_protocol! {
HTTP, "http", 80;
HTTPS, "https", 443;
FTP, "ftp", 21;
WS, "ws", 80;
WSS, "wss", 443;
}
/// Create a URL prefix string.
pub fn create_prefix<S: AsRef<str>, P: AsRef<str>>(
protocol: Protocol,
domain: S,
port: Option<u16>,
path: Option<P>,
) -> String {
let protocol_name = protocol.get_name();
let mut prefix = format!("{}://{}", protocol_name, domain.as_ref());
if let Some(port) = port {
let protocol_port = protocol.get_default_port();
if port != protocol_port {
prefix.write_fmt(format_args!(":{}", port)).unwrap();
}
}
if let Some(path) = path {
let path = path.as_ref();
slash_formatter::concat_with_slash_in_place(&mut prefix, path);
}
prefix
}