Struct Route 

pub struct Route {

    pub id: &'static str,
    pub service: &'static str,
    pub method: Method,
    pub path: &'static str,
    pub pattern: &'static str,
    pub resource: &'static str,
    pub resource_type: &'static str,
    pub params: &'static [RouteParam],
    pub idempotent: bool,
    pub readonly: bool,
    pub html: bool,
    pub empty_on: &'static [u16],
    pub pagination: Pagination,
    pub retry: Retry,
}

One API operation: its method, its path template and the behaviour the Smithy model attaches to it. Every route the SDK knows lives in crate::routes.

Fields

id: &'static str

The operation as the model names it: ListBoxes, GetTopic.

service: &'static str

The service handle whose method sends this route, as every HEY SDK names it: Boxes, TimeTracks.

method: Method

The HTTP method the route is sent with.

path: &'static str

The path as HEY serves it, {param} placeholders included.

pattern: &'static str

The path without a .json suffix, for recognizing pasted URLs.

resource: &'static str

The part of HEY the route belongs to, as the model titles it: Boxes, Calendar Time Tracks.

resource_type: &'static str

The kind of record the route acts on, in snake_case: box, box_group.

params: &'static [RouteParam]

The path parameters, in the order they appear in Route::path.

idempotent: bool

The route may be sent again after a failure without doing its work twice.

readonly: bool

The route only reads; nothing it does changes anything.

html: bool

The route answers a page as HTML rather than a JSON document, so it is asked for as written — no .json suffix — with Accept: text/html.

empty_on: &'static [u16]

The statuses that mean HEY has nothing for this route rather than that it failed — a 404 for a record that may simply not be there. Such an answer is empty, not an error.

pagination: Pagination

How the route pages, when it does.

retry: Retry

The retry policy the model attaches to the route.

Implementations

impl Route

pub fn fill(&self, values: &[&dyn Display]) -> String

Substitutes the path parameters, in order, percent-encoding each value.

Panics

When values is not exactly as long as Route::params. A short list would leave a {param} in the path and send it to HEY as written, which is worse than stopping; every generated caller passes the right count, so reaching this means the call was built by hand and built wrong.

pub fn recognize(&self, path: &str) -> Option<Vec<(&'static str, String)>>

Matches a path against the route’s pattern and answers the captured parameters.

Trait Implementations

impl Debug for Route

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

Formats the value using the given formatter.