Skip to content

Commit

Permalink
multiaddr: feature gate url dependency (#1843)
Browse files Browse the repository at this point in the history
* multiaddr: feature gate url dependency

Make it possible to exclude url and its dependencies
from the dependency tree, by feature gating the
from_url* functions in the public API.

* Document feature gating of multiaddr::from_url*
  • Loading branch information
mzabaluev authored Nov 17, 2020
1 parent 41d3f72 commit fe6e622
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
5 changes: 4 additions & 1 deletion misc/multiaddr/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ keywords = ["multiaddr", "ipfs"]
license = "MIT"
version = "0.9.5"

[features]
default = ["url"]

[dependencies]
arrayref = "0.3"
bs58 = "0.4.0"
Expand All @@ -18,7 +21,7 @@ percent-encoding = "2.1.0"
serde = "1.0.70"
static_assertions = "1.1"
unsigned-varint = "0.5"
url = { version = "2.1.0", default-features = false }
url = { version = "2.1.0", optional = true, default-features = false }

[dev-dependencies]
bincode = "1"
Expand Down
6 changes: 6 additions & 0 deletions misc/multiaddr/src/from_url.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ use std::{error, fmt, iter, net::IpAddr};
/// generated multiaddress. This includes a username, password, path (if not supported by the
/// multiaddr), and query string.
///
/// This function is only present if the `url` feature is enabled, and it is
/// enabled by default.
///
/// The supported URL schemes are:
///
/// - `ws://example.com/`
Expand All @@ -31,6 +34,9 @@ pub fn from_url(url: &str) -> std::result::Result<Multiaddr, FromUrlErr> {
/// This function is similar to [`from_url`], except that we don't return an error if some
/// information in the URL cannot be retain in the generated multiaddres.
///
/// This function is only present if the `url` feature is enabled, and it is
/// enabled by default.
///
/// # Example
///
/// ```
Expand Down
6 changes: 5 additions & 1 deletion misc/multiaddr/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ pub use multihash;
mod protocol;
mod onion_addr;
mod errors;

#[cfg(feature = "url")]
mod from_url;

use serde::{
Expand All @@ -25,10 +27,12 @@ use std::{
sync::Arc
};
pub use self::errors::{Result, Error};
pub use self::from_url::{FromUrlErr, from_url, from_url_lossy};
pub use self::protocol::Protocol;
pub use self::onion_addr::Onion3Addr;

#[cfg(feature = "url")]
pub use self::from_url::{FromUrlErr, from_url, from_url_lossy};

static_assertions::const_assert! {
// This check is most certainly overkill right now, but done here
// anyway to ensure the `as u64` casts in this crate are safe.
Expand Down

0 comments on commit fe6e622

Please sign in to comment.