Struct URIReferenceBuilder

Source

pub struct URIReferenceBuilder<'uri> { /* private fields */ }

Expand description

A builder type for [URIReference].

You must use the URIReference::path function before building as URI references always have have a path. Everything else is optional.

Implementations§

Source §

impl<'uri> URIReferenceBuilder<'uri>

Source

pub fn authority(&mut self, authority: Option<Authority<'uri>>) -> &mut Self

Sets the authority part of the URI reference.

It is optional to specify a authority.

§Examples

use std::convert::TryFrom;

use uriparse::{Authority, Path, URIReferenceBuilder};

let mut builder = URIReferenceBuilder::new();
builder
    .authority(Some(Authority::try_from("example.com").unwrap()))
    .path(Path::try_from("/my/path").unwrap());
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "//example.com/my/path");

Source

pub fn build(self) -> Result<URIReference<'uri>, URIReferenceError>

Consumes the builder and tries to build a URIReference.

This function will error in one of two situations:

A path was not specified in the builder.
While all individual components were valid, their combination as a URI reference was invalid.

§Examples

First error type (path not specified):

use uriparse::URIReferenceBuilder;

let result = URIReferenceBuilder::new().build();
assert!(result.is_err());

Second error type (first segment in schemeless path cannot contain a ':'):

use std::convert::TryFrom;

use uriparse::{Path, URIReferenceBuilder};

let result = URIReferenceBuilder::new()
    .with_path(Path::try_from("my:/path").unwrap())
    .build();
assert!(result.is_err());

Source

pub fn fragment(&mut self, fragment: Option<Fragment<'uri>>) -> &mut Self

Sets the fragment part of the URI reference.

It is optional to specify a fragment.

§Examples

use std::convert::TryFrom;

use uriparse::{Fragment, Path, URIReferenceBuilder};

let mut builder = URIReferenceBuilder::new();
builder
    .path(Path::try_from("/my/path").unwrap())
    .fragment(Some(Fragment::try_from("fragment").unwrap()));
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "/my/path#fragment");

Source

pub fn new() -> Self

Constructs a new builder with nothing set.

Source

pub fn path(&mut self, path: Path<'uri>) -> &mut Self

Sets the path part of the URI reference.

It is required to specify a path. Not doing so will result in an error during the URIReferenceBuilder::build function.

§Examples

use std::convert::TryFrom;

use uriparse::{Path, URIReferenceBuilder};

let mut builder = URIReferenceBuilder::new();
builder
    .path(Path::try_from("/my/path").unwrap());
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "/my/path");

Source

pub fn query(&mut self, query: Option<Query<'uri>>) -> &mut Self

Sets the query part of the URI reference.

It is optional to specify a query.

§Examples

use std::convert::TryFrom;

use uriparse::{Path, Query, URIReferenceBuilder};

let mut builder = URIReferenceBuilder::new();
builder
    .path(Path::try_from("/my/path").unwrap())
    .query(Some(Query::try_from("query").unwrap()));
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "/my/path?query");

Source

pub fn scheme(&mut self, scheme: Option<Scheme<'uri>>) -> &mut Self

Sets the scheme part of the URI reference.

It is optional to specify a scheme.

§Examples

use std::convert::TryFrom;

use uriparse::{Authority, Path, Scheme, URIReferenceBuilder};

let mut builder = URIReferenceBuilder::new();
builder
    .scheme(Some(Scheme::HTTP))
    .authority(Some(Authority::try_from("example.com").unwrap()))
    .path(Path::try_from("/my/path").unwrap());
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "http://example.com/my/path");

Source

pub fn try_authority<TAuthority, TAuthorityError>( &mut self, authority: Option<TAuthority>, ) -> Result<&mut Self, TAuthorityError>
where Authority<'uri>: TryFrom<TAuthority, Error = TAuthorityError>, AuthorityError: From<TAuthorityError>,

Sets the authority part of the URI reference.

If the given authority is not a valid authority (i.e. the conversion fails), an error is return.

It is optional to specify an authority.

§Examples

use uriparse::URIReferenceBuilder;

let mut builder = URIReferenceBuilder::new();
builder
    .try_authority(Some("example.com"))
    .unwrap()
    .try_path("/my/path")
    .unwrap();
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "//example.com/my/path");

Source

pub fn try_fragment<TFragment, TFragmentError>( &mut self, fragment: Option<TFragment>, ) -> Result<&mut Self, FragmentError>
where Fragment<'uri>: TryFrom<TFragment, Error = TFragmentError>, FragmentError: From<TFragmentError>,

Sets the fragment part of the URI reference.

If the given fragment is not a valid fragment (i.e. the conversion fails), an error is returned.

It is optional to specify a fragment.

§Examples

use uriparse::URIReferenceBuilder;

let mut builder = URIReferenceBuilder::new();
builder
    .try_path("/my/path")
    .unwrap()
    .try_fragment(Some("fragment"))
    .unwrap();
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "/my/path#fragment");

Source

pub fn try_path<TPath, TPathError>( &mut self, path: TPath, ) -> Result<&mut Self, PathError>
where Path<'uri>: TryFrom<TPath, Error = TPathError>, PathError: From<TPathError>,

Sets the path part of the URI reference.

If the given path is not a valid path (i.e. the conversion fails), an error is returned.

It is required to specify a path. Not doing so will result in an error during the URIReferenceBuilder::build function.

§Examples

use uriparse::URIReferenceBuilder;

let mut builder = URIReferenceBuilder::new();
builder
    .try_path("/my/path")
    .unwrap();
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "/my/path");

Source

pub fn try_query<TQuery, TQueryError>( &mut self, query: Option<TQuery>, ) -> Result<&mut Self, QueryError>
where Query<'uri>: TryFrom<TQuery, Error = TQueryError>, QueryError: From<TQueryError>,

Sets the query part of the URI reference.

If the given query is not a valid query (i.e. the conversion fails), an error is returned.

It is optional to specify a query.

§Examples

use uriparse::URIReferenceBuilder;

let mut builder = URIReferenceBuilder::new();
builder
    .try_path("/my/path")
    .unwrap()
    .try_query(Some("query"))
    .unwrap();
let reference = builder.build().unwrap();
assert_eq!(reference.to_string(), "/my/path?query");

Source

pub fn try_scheme<TScheme, TSchemeError>( &mut self, scheme: Option<TScheme>, ) -> Result<&mut Self, SchemeError>
where Scheme<'uri>: TryFrom<TScheme, Error = TSchemeError>, SchemeError: From<TSchemeError>,

Sets the scheme part of the URI reference.

If the given scheme is not a valid scheme (i.e. the conversion fails), an error is returned.

It is optional to specify a scheme.

§Examples

use uriparse::URIReferenceBuilder;

let mut builder = URIReferenceBuilder::new();
builder
    .try_scheme(Some("urn"))
    .unwrap()
    .try_path("path")
    .unwrap();
let uri = builder.build().unwrap();
assert_eq!(uri.to_string(), "urn:path");

Source

pub fn with_authority(self, authority: Option<Authority<'uri>>) -> Self

Consumes the builder and sets the authority part of the URI reference.

It is optional to specify an authority.

§Examples

use std::convert::TryFrom;

use uriparse::{Authority, Path, URIReferenceBuilder};

let reference = URIReferenceBuilder::new()
    .with_authority(Some(Authority::try_from("example.com").unwrap()))
    .with_path(Path::try_from("/").unwrap())
    .build()
    .unwrap();
assert_eq!(reference.to_string(), "//example.com/")

Source

pub fn with_fragment(self, fragment: Option<Fragment<'uri>>) -> Self

Consumes the builder and sets the fragment part of the URI reference.

It is optional to specify a fragment.

§Examples

use std::convert::TryFrom;

use uriparse::{Fragment, Path, URIReferenceBuilder};

let reference = URIReferenceBuilder::new()
    .with_path(Path::try_from("/").unwrap())
    .with_fragment(Some(Fragment::try_from("fragment").unwrap()))
    .build()
    .unwrap();
assert_eq!(reference.to_string(), "/#fragment")

Source

pub fn with_path(self, path: Path<'uri>) -> Self

Consumes the builder and sets the path part of the URI reference.

It is required to specify a path. Not doing so will result in an error during the URIReferenceBuilder::build function.

§Examples

use std::convert::TryFrom;

use uriparse::{Path, URIReferenceBuilder};

let reference = URIReferenceBuilder::new()
    .with_path(Path::try_from("/").unwrap())
    .build()
    .unwrap();
assert_eq!(reference.to_string(), "/")

Source

pub fn with_query(self, query: Option<Query<'uri>>) -> Self

Consumes the builder and sets the query part of the URI reference.

It is optional to specify a query.

§Examples

use std::convert::TryFrom;

use uriparse::{Path, Query, URIReferenceBuilder};

let reference = URIReferenceBuilder::new()
    .with_path(Path::try_from("/").unwrap())
    .with_query(Some(Query::try_from("query").unwrap()))
    .build()
    .unwrap();
assert_eq!(reference.to_string(), "/?query")

Source

pub fn with_scheme(self, scheme: Option<Scheme<'uri>>) -> Self

Consumes the builder and sets the scheme part of the URI reference.

It is optional to specify a scheme.

§Examples

use std::convert::TryFrom;

use uriparse::{Authority, Path, Scheme, URIReferenceBuilder};

let reference = URIReferenceBuilder::new()
    .with_scheme(Some(Scheme::HTTP))
    .with_authority(Some(Authority::try_from("example.com").unwrap()))
    .with_path(Path::try_from("/").unwrap())
    .build()
    .unwrap();
assert_eq!(reference.to_string(), "http://example.com/")