Skip to main content

Crate use_api_route

Crate use_api_route 

Source
Expand description

§use-api-route

API route template primitives for RustUse.

Models route templates and route segment metadata for static, dynamic, wildcard, and optional segments without implementing a full router.

§Example

use use_api_route::{RouteSegmentKind, RouteTemplate};

let value = RouteTemplate::new("/users/:id").expect("valid API primitive");

assert_eq!(value.as_str(), "/users/:id");
assert_eq!(RouteSegmentKind::Static.to_string(), "static");

§Scope

  • Small validated types for API metadata.
  • Stable display labels and conservative parsing helpers.
  • Dependency-light primitives that can be reused by other RustUse crates.

§Non-goals

  • No full router.
  • No regex matching engine.
  • No middleware or server integration.

§License

Licensed under either of the following, at your option:

  • Apache License, Version 2.0
  • MIT license

Structs§

DynamicParam
OptionalSegment
PrimitiveMetadata
Lightweight metadata tying this crate’s primary text and label together.
RouteSegment
Lightweight route segment metadata.
RouteTemplate
StaticSegment
WildcardParam

Enums§

ApiPrimitiveError
Error returned when API primitive text or labels are invalid.
RouteMatchKind
Route matching metadata labels.
RouteSegmentKind
Route segment kind labels.