Struct Param

pub struct Param<'a> { /* private fields */ }

A web-based URL query parameter.

Validation

Both the name and value of a query parameter may be the empty string. The value string may also be absent altogether which signifies a missing ‘=’ in the query parameter string.

Query parameter names & values can contain any US-ASCII letters, numbers, or punctuation chars excluding ‘&’ and ‘#’ since these chars denote the end of the parameter or query in the URL. Names cannot contain the ‘=’ char since this denotes the end of the query parameter name.

Implementations

impl<'a> Param<'a>

Construction

pub unsafe fn new(name: &'a str, value: Option<&'a str>) -> Self

Creates a new query parameter.

Safety

The name and value must be valid.

pub unsafe fn from_str(param: &'a str) -> Self

Creates a new query parameter from the param.

The param will be split on the first ‘=’ char. If not present the value will be None.

Safety

The param must be valid.

impl<'a> Param<'a>

Validation

pub fn is_valid_name(name: &str) -> bool

Checks if the name is valid.

pub fn is_valid_value(value: &str) -> bool

Checks if the value is valid.

impl<'a> Param<'a>

Properties

pub const fn name(&self) -> &str

Gets the name.

pub const fn value(&self) -> Option<&str>

Gets the optional value.

Trait Implementations

impl<'a> Clone for Param<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Param<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Param<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Param<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Param<'a>

fn cmp(&self, other: &Param<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Param<'a>

fn eq(&self, other: &Param<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for Param<'a>

fn partial_cmp(&self, other: &Param<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFrom<&'a str> for Param<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(param: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for Param<'a>

impl<'a> Eq for Param<'a>

impl<'a> StructuralPartialEq for Param<'a>