Struct uriparse::uri::RelativeReferenceBuilder

pub struct RelativeReferenceBuilder<'uri> { /* fields omitted */ }

A builder type for [RelativeReference].

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

Methods

impl<'uri> RelativeReferenceBuilder<'uri>

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets the authority part of the relative reference.

If the given authority is not a valid authority (i.e. the conversion fails), an error is stored internally and checked during the RelativeReferenceBuilder::build function. The error state will be rewritten for any following calls to this function.

It is optional to specify an authority.

Examples

use uriparse::RelativeReferenceBuilder;

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

pub fn build(self) -> Result<RelativeReference<'uri>, InvalidRelativeReference>

Consumes the builder and tries to build a RelativeReference.

This function will error in one of three situations:

• One of the components specified in the builder is invalid.
• A path was not specified in the builder.
• While all individual components were valid, their combination as a relative reference was invalid.

Examples

First error type (invalid path):

use uriparse::RelativeReferenceBuilder;

let mut builder = RelativeReferenceBuilder::new();
builder.path("this is an invalid path %%%");
assert!(builder.build().is_err());

Second error type (path not specified):

use uriparse::RelativeReferenceBuilder;

let builder = RelativeReferenceBuilder::new();
assert!(builder.build().is_err());

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

use uriparse::RelativeReferenceBuilder;

let mut builder = RelativeReferenceBuilder::new();
builder.path("my:/path");
assert!(builder.build().is_err());

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets the fragment part of the relative reference.

If the given fragment is not a valid fragment (i.e. the conversion fails), an error is stored internally and checked during the RelativeReferenceBuilder::build function. The error state will be rewritten for any following calls to this function.

It is optional to specify a fragment.

Examples

use uriparse::RelativeReferenceBuilder;

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

pub fn new() -> Self

Constructs a new builder with nothing set.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn path<PathType, PathError>(&mut self, path: PathType) -> &mut Self where     Path<'uri>: TryFrom<PathType, Error = PathError>,     InvalidPath: From<PathError>,

Sets the path part of the relative reference.

If the given path is not a valid path (i.e. the conversion fails), an error is stored internally and checked during the RelativeReferenceBuilder::build function. The error state will be rewritten for any following calls to this function.

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

Examples

use uriparse::RelativeReferenceBuilder;

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

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Sets the query part of the relative reference.

If the given query is not a valid query (i.e. the conversion fails), an error is stored internally and checked during the RelativeReferenceBuilder::build function. The error state will be rewritten for any following calls to this function.

It is optional to specify a query.

Examples

use uriparse::RelativeReferenceBuilder;

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

Trait Implementations

impl<'uri> Clone for RelativeReferenceBuilder<'uri>

fn clone(&self) -> RelativeReferenceBuilder<'uri>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'uri> Debug for RelativeReferenceBuilder<'uri>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'uri> Default for RelativeReferenceBuilder<'uri>

fn default() -> RelativeReferenceBuilder<'uri>

Returns the "default value" for a type.

impl<'uri> Eq for RelativeReferenceBuilder<'uri>

impl<'uri> PartialEq for RelativeReferenceBuilder<'uri>

fn eq(&self, other: &RelativeReferenceBuilder<'uri>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RelativeReferenceBuilder<'uri>) -> bool

This method tests for !=.