Crate spring_macros

Routing and runtime macros for spring.rs.

spring.rs Re-exports

spring.rs re-exports a version of this crate in it’s entirety so you usually don’t have to specify a dependency on this crate explicitly. Sometimes, however, updates are made to this crate before the spring.rs dependency is updated. Therefore, code examples here will show explicit imports. Check the latest [spring.rs attributes docs] to see which macros are re-exported.

Single Method Handler

There is a macro to set up a handler for each of the most common HTTP methods that also define additional guards and route-specific middleware.

See docs for: [GET], [POST], [PATCH], [PUT], [DELETE], [HEAD], [CONNECT], [OPTIONS], [TRACE]

#[get("/test")]
async fn get_handler() -> impl IntoResponse {
    "hello world"
}

Multiple Method Handlers

Similar to the single method handler macro but takes one or more arguments for the HTTP methods it should respond to. See route macro docs.

#[route("/test", method = "GET", method = "HEAD")]
async fn get_and_head_handler() -> impl IntoResponse {
    "hello world"
}

Multiple Path Handlers

Acts as a wrapper for multiple single method handler macros. It takes no arguments and delegates those to the macros for the individual methods. See routes macro docs.

#[routes]
#[get("/test")]
#[get("/test2")]
#[delete("/test")]
async fn example() -> impl IntoResponse {
    "hello world"
}

Attribute Macros

• auto_config
  Auto config
• cron
  Syntax
• delete
  Syntax
• fix_delay
  Syntax
• fix_rate
  Syntax
• get
  Syntax
• head
  Syntax
• nest
  Prepends a path prefix to all handlers using routing macros inside the attached module.
• one_shot
  Syntax
• options
  Syntax
• patch
  Syntax
• post
  Syntax
• put
  Syntax
• route
  Creates resource handler, allowing multiple HTTP method guards.
• routes
  Creates resource handler, allowing multiple HTTP methods and paths.
• trace
  Syntax

Derive Macros

• Configurable
  Configurable Plugin