New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce a Uri Builder #219
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
use {Uri, Result}; | ||
use convert::{HttpTryFrom, HttpTryInto}; | ||
use super::{Authority, Scheme, Parts, PathAndQuery}; | ||
|
||
/// A builder for `Uri`s. | ||
/// | ||
/// This type can be used to construct an instance of `Uri` | ||
/// through a builder pattern. | ||
#[derive(Debug)] | ||
pub struct Builder { | ||
parts: Option<Result<Parts>>, | ||
} | ||
|
||
impl Builder { | ||
/// Creates a new default instance of `Builder` to construct a `Uri`. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// # use http::*; | ||
/// | ||
/// let uri = uri::Builder::new() | ||
/// .scheme("https") | ||
/// .authority("hyper.rs") | ||
/// .path_and_query("/") | ||
/// .build() | ||
/// .unwrap(); | ||
/// ``` | ||
#[inline] | ||
pub fn new() -> Builder { | ||
Builder::default() | ||
} | ||
|
||
/// Set the `Scheme` for this URI. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// # use http::*; | ||
/// | ||
/// let mut builder = uri::Builder::new(); | ||
/// builder.scheme("https"); | ||
/// ``` | ||
pub fn scheme<T>(&mut self, scheme: T) -> &mut Self | ||
where | ||
Scheme: HttpTryFrom<T>, | ||
{ | ||
self.map(|parts| { | ||
parts.scheme = Some(scheme.http_try_into()?); | ||
Ok(()) | ||
}) | ||
} | ||
|
||
/// Set the `Authority` for this URI. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// # use http::*; | ||
/// | ||
/// let uri = uri::Builder::new() | ||
/// .authority("tokio.rs") | ||
/// .build() | ||
/// .unwrap(); | ||
/// ``` | ||
pub fn authority<T>(&mut self, auth: T) -> &mut Self | ||
where | ||
Authority: HttpTryFrom<T>, | ||
{ | ||
self.map(|parts| { | ||
parts.authority = Some(auth.http_try_into()?); | ||
Ok(()) | ||
}) | ||
} | ||
|
||
/// Set the `PathAndQuery` for this URI. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// # use http::*; | ||
/// | ||
/// let uri = uri::Builder::new() | ||
/// .path_and_query("/hello?foo=bar") | ||
/// .build() | ||
/// .unwrap(); | ||
/// ``` | ||
pub fn path_and_query<T>(&mut self, p_and_q: T) -> &mut Self | ||
where | ||
PathAndQuery: HttpTryFrom<T>, | ||
{ | ||
self.map(|parts| { | ||
parts.path_and_query = Some(p_and_q.http_try_into()?); | ||
Ok(()) | ||
}) | ||
} | ||
|
||
/// Consumes this builder, and tries to construct a valid `Uri` from | ||
/// the configured pieces. | ||
/// | ||
/// # Errors | ||
/// | ||
/// This function may return an error if any previously configured argument | ||
/// failed to parse or get converted to the internal representation. For | ||
/// example if an invalid `scheme` was specified via `scheme("!@#%/^")` | ||
/// the error will be returned when this function is called rather than | ||
/// when `scheme` was called. | ||
/// | ||
/// Additionally, the various forms of URI require certain combinations of | ||
/// parts to be set to be valid. If the parts don't fit into any of the | ||
/// valid forms of URI, a new error is returned. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// # use http::*; | ||
/// | ||
/// let uri = Uri::builder() | ||
/// .build() | ||
/// .unwrap(); | ||
/// ``` | ||
pub fn build(&mut self) -> Result<Uri> { | ||
self | ||
.parts | ||
.take() | ||
.expect("cannot reuse Uri builder") | ||
.and_then(|parts| parts.http_try_into()) | ||
} | ||
|
||
fn map<F>(&mut self, f: F) -> &mut Self | ||
where | ||
F: FnOnce(&mut Parts) -> Result<()>, | ||
{ | ||
let res = if let Some(Ok(ref mut parts)) = self.parts { | ||
f(parts) | ||
} else { | ||
return self; | ||
}; | ||
|
||
if let Err(err) = res { | ||
self.parts = Some(Err(err)); | ||
} | ||
|
||
self | ||
} | ||
} | ||
|
||
impl Default for Builder { | ||
#[inline] | ||
fn default() -> Builder { | ||
Builder { | ||
parts: Some(Ok(Parts::default())), | ||
} | ||
} | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this added for internal convenience or does it impact the public api somehow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, it was internal convenience, allowing
arg.http_try_into()
instead of<T as HttpTryFrom<U>>::try_from(arg)
. Since the trait isn't public, and no one can import it, it exposes no public contract.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me.