A library for the programming language Rust.
This is a thin wrapper over the Url crate which eliminates the potential
for errors related to valid Url which cannot be a base by checking that the Url can be a base on
creation. As such, a BaseUrl never fails when doing things like calling set_path()
In any Rust project managed by Cargo add the following to your Cargo.toml [dependencies] section:
base_url="0.0.10"
The package exposes baseurl which defines the BaseUrl structure at it's root and also re-exports the
content of the rust-url and tryfrom crates by default.
rust
extern crate base_url;
use base_url::BaseUrl;
use base_url::Url;
use base_url::TryFrom;
There are also two related error types, one a re-export of the rust-url error type, the other expresses
errors related to host suitability when converting into a BaseUrl.
rust
use base_url::ParseError;
use base_url::BaseUrlError;
BaseUrl can be created by converting from a String or a Url, these conversions are implemented using
the standard From trait and can panic, the panic-free try_from implementations are recommended
instead.
One default feature exists, _try_from which adds the try_from
crate and panic-free implementations of the standard set of conversions. If you are on nightly this
feature should do nothing and the standard library implementation will be used instead.
There are 2 features which can be opted into robot_conversions and sitemap_conversions.
Each of these features adds a conversion into the important types of the crates robotparser and
sitemap respectively.
If you wish to add your own conversions (for a crate you don't own at least), look at those
implementations given in src/conversions.rs as well as the dependency hierarchy in
Cargo.toml
This is at version 0.0.10 for a reason, there are things to be added before I'm comfortable claiming
this library is at a proper first version.
Tests should be added, even though this is mostly just a thin wrapper over the Url type proving
that CannotBeBase errors are truly gone when using the library is something which should be done
Finally there are some functions which are still missing, anything which requires me to reimplement the parse()
function isn't being touched until I really need to, notably join() isn't available yet.