Skip to main content

QueryParams

Struct QueryParams 

Source
pub struct QueryParams { /* private fields */ }
Expand description

Query parameters from an agent URI.

Stores key-value pairs from the query string, sorted lexicographically by key for consistent normalization.

§Reserved Parameters

  • version: Capability version constraint (semver)
  • attestation: Inline PASETO attestation token
  • resolver: Hint for resolution endpoint
  • ttl: Cache TTL hint in seconds

Implementations§

Source§

impl QueryParams

Source

pub fn new() -> Self

Creates an empty query params instance.

Source

pub fn parse(input: &str) -> Result<Self, QueryError>

Parses query parameters from a query string (without leading ‘?’).

§Errors

Returns QueryError if any parameter is invalid.

Source

pub fn get(&self, name: &str) -> Option<&str>

Returns the value for a parameter, if present.

Source

pub fn is_empty(&self) -> bool

Returns true if the query is empty.

Source

pub fn len(&self) -> usize

Returns the number of parameters.

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Returns an iterator over the parameters.

Source

pub fn version(&self) -> Option<&str>

Returns the version parameter, if present.

Source

pub fn ttl(&self) -> Option<u64>

Returns the TTL parameter, if present.

Source

pub fn with_param(&self, key: &str, value: &str) -> Result<Self, QueryError>

Returns a new query with the given parameter added or updated.

§Errors

Returns QueryError if the key or value is invalid.

§Examples
use agent_uri::QueryParams;

let query = QueryParams::new();
let updated = query.with_param("version", "2.0").unwrap();
assert_eq!(updated.get("version"), Some("2.0"));
Source

pub fn without_param(&self, key: &str) -> Self

Returns a new query without the given parameter.

§Examples
use agent_uri::QueryParams;

let query = QueryParams::parse("version=2.0&ttl=300").unwrap();
let updated = query.without_param("ttl");
assert!(updated.get("ttl").is_none());
assert_eq!(updated.get("version"), Some("2.0"));
Source

pub fn with_version(&self, v: &str) -> Result<Self, QueryError>

Returns a new query with the version parameter set.

§Errors

Returns QueryError if the version string is invalid.

§Examples
use agent_uri::QueryParams;

let query = QueryParams::new();
let updated = query.with_version("2.0").unwrap();
assert_eq!(updated.version(), Some("2.0"));
Source

pub fn with_ttl(&self, ttl: u64) -> Result<Self, QueryError>

Returns a new query with the TTL parameter set.

§Errors

Returns QueryError if the resulting query would be invalid.

§Examples
use agent_uri::QueryParams;

let query = QueryParams::new();
let updated = query.with_ttl(300).unwrap();
assert_eq!(updated.ttl(), Some(300));

Trait Implementations§

Source§

impl Clone for QueryParams

Source§

fn clone(&self) -> QueryParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QueryParams

Source§

fn default() -> QueryParams

Returns the “default value” for a type. Read more
Source§

impl Display for QueryParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for QueryParams

Source§

impl FromStr for QueryParams

Source§

type Err = QueryError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Ord for QueryParams

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for QueryParams

Source§

fn eq(&self, other: &QueryParams) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for QueryParams

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for QueryParams

Source§

impl TryFrom<&str> for QueryParams

Source§

type Error = QueryError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.