Struct PathTemplate 

pub struct PathTemplate { /* private fields */ }

A parsed path template such as /users/{id}/posts/{postId}.

Two templates that differ only in variable name are the same path as far as OpenAPI is concerned, so declaring both is invalid. normalized exists to make that comparison cheap.

Implementations

impl PathTemplate

pub fn parse(raw: impl Into<String>) -> Result<Self, InvalidPathTemplate>

Parses a path template.

Literal segments are checked against the path grammar; variable names are not, because the grammar admits every character except a brace there. A name that Kynos’s router cannot match — a catch-all, say — is still a legal OpenAPI template, and this type has to be able to hold one so that an externally authored description round-trips. That narrower contract is enforced where routes are registered.

Errors

Returns InvalidPathTemplate when the template does not start with /, has unbalanced or empty braces, repeats a variable, carries a query string or fragment, or holds a character the path grammar does not allow outside a {} expression.

pub fn as_str(&self) -> &str

The template exactly as written.

pub fn variables(&self) -> &[String]

The variable names, in the order they appear.

pub fn normalized(&self) -> String

The template with every variable name replaced by {}.

Two templates are the same path if and only if their normalized forms are equal.

pub fn with_prefix(&self, prefix: &str) -> Result<Self, InvalidPathTemplate>

Concatenates a prefix onto this template, as nesting does.

Errors

Returns InvalidPathTemplate when the result is not a valid template, which is how a prefix that repeats one of this template’s variables is caught.

Trait Implementations

impl Clone for PathTemplate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathTemplate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PathTemplate

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

Formats the value using the given formatter.

impl Eq for PathTemplate

impl From<PathTemplate> for String

fn from(template: PathTemplate) -> Self

Converts to this type from the input type.

impl FromStr for PathTemplate

type Err = InvalidPathTemplate

The associated error which can be returned from parsing.

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

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

impl Hash for PathTemplate

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 PartialEq for PathTemplate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PathTemplate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PathTemplate

impl TryFrom<String> for PathTemplate

type Error = InvalidPathTemplate

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.