Struct QueryParams 

pub struct QueryParams { /* private fields */ }

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

impl QueryParams

pub fn new() -> Self

Creates an empty query params instance.

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.

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

Returns the value for a parameter, if present.

pub fn is_empty(&self) -> bool

Returns true if the query is empty.

pub fn len(&self) -> usize

Returns the number of parameters.

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

Returns an iterator over the parameters.

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

Returns the version parameter, if present.

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

Returns the TTL parameter, if present.

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"));

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"));

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"));

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

impl Clone for QueryParams

fn clone(&self) -> QueryParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryParams

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

Formats the value using the given formatter.

impl Default for QueryParams

fn default() -> QueryParams

Returns the “default value” for a type.

impl Display for QueryParams

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

Formats the value using the given formatter.

impl Eq for QueryParams

impl FromStr for QueryParams

type Err = QueryError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Ord for QueryParams

fn cmp(&self, other: &Self) -> 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 PartialEq for QueryParams

fn eq(&self, other: &QueryParams) -> 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 PartialOrd for QueryParams

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for QueryParams

impl TryFrom<&str> for QueryParams

type Error = QueryError

The type returned in the event of a conversion error.

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

Performs the conversion.