Struct url::ParseOptions

pub struct ParseOptions<'a> {
    pub(crate) base_url: Option<&'a Url>,
    pub(crate) encoding_override: EncodingOverride<'a>,
    pub(crate) violation_fn: Option<&'a dyn Fn(SyntaxViolation)>,
}

Full configuration for the URL parser.

Fields

base_url: Option<&'a Url>

encoding_override: EncodingOverride<'a>

violation_fn: Option<&'a dyn Fn(SyntaxViolation)>

Implementations

impl<'a> ParseOptions<'a>

pub fn base_url(self, new: Option<&'a Url>) -> Self

Change the base URL

See the notes of Url::join for more details about how this base is considered when parsing.

pub fn encoding_override(self, new: EncodingOverride<'a>) -> Self

Override the character encoding of query strings. This is a legacy concept only relevant for HTML.

pub fn syntax_violation_callback( self, new: Option<&'a dyn Fn(SyntaxViolation)>, ) -> Self

Call the provided function or closure for a non-fatal SyntaxViolation when it occurs during parsing. Note that since the provided function is Fn, the caller might need to utilize interior mutability, such as with a RefCell, to collect the violations.

Example

use std::cell::RefCell;
use url::{Url, SyntaxViolation};
let violations = RefCell::new(Vec::new());
let url = Url::options()
    .syntax_violation_callback(Some(&|v| violations.borrow_mut().push(v)))
    .parse("https:////example.com")?;
assert_eq!(url.as_str(), "https://example.com/");
assert_eq!(violations.into_inner(),
           vec!(SyntaxViolation::ExpectedDoubleSlash));

pub fn parse(self, input: &str) -> Result<Url, ParseError>

Parse an URL string with the configuration so far.

Trait Implementations

impl<'a> Clone for ParseOptions<'a>

fn clone(&self) -> ParseOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ParseOptions<'a>