Crate afire

🔥 afire

THIS IS AN ALPHA RELEASE FOR v3.0.0 – Its probably not the best idea to use this in production and it will definitely have a lot of breaking changes in the future.

afire is a blazingly fast web server micro framework for rust.

💠 Install

Just add the following to your Cargo.toml:

[dependencies]
afire = "3.0.0-alpha.3"

📄 Info

afire is a simple synchronous multithreaded express.js inspired rust web micro framework. wow that was long. It comes with some built extensions in for Static File Serving, Rate limiting, and more.

Below you can find links to some afire related resources.

• Homepage
• Crates.io page
• API Docs

💥 Example

For more examples see the examples directory here.

Below is a super simple example so you can see the basics of afire syntax.

use afire::prelude::*;

let mut server = Server::<()>::new("localhost", 8080);

server.route(Method::GET, "/greet/{name}", |ctx| {
  let name = ctx.param("name");

  ctx.text(format!("Hello, {}", name))
      .content(Content::TXT)
      .send()?;

  Ok(())
});

server.run().unwrap();

💼 License

afire is licensed under the MIT license so you are free to do basically whatever you want with it as long as you add a copyright notice. You can read the full license text here.

Modules

• cookie
  Cookies! This module provides a simple interface for setting and receiving cookies.
• error
  Errors that can occur in the process of connecting to clients, parsing HTTP and handling requests.
• extensions
  Useful extensions to the base afire. Includes helpful middleware like Serve Static, Rate Limit and Logger.
• header
  HTTP headers.
• headers
  Contains all the header structs that can be used with HTTP requests and responses.
• internal
  Internal Functions.
• middleware
  Middleware is code that runs before and after the routes. They can be used to Log Requests, Ratelimit Requests, add Analytics, etc. For more information, see the Middleware Example.
• multipart
  Multipart request parsing.
• prelude
  The prelude is a collection of types and traits that are commonly used in most afire applications.
• proto
  Protocol implementations.
• route
  Stuff for defining routes and error handling in routes. Holds RouteContext and AdditionalRouteContext, which are used to add context to errors. The context can include a message, status code, and headers.
• server_sent_events
  Server-sent event (SSE) support.
• trace
  This is afire’s built-in logging system. Enabled with the tracing feature (enabled by default). The default log level is Level::Error.
• websocket
  WebSocket support.

Macros

• trace
  Simple logging system. See crate::trace for more information.

Structs

• Context
  A collection of data important for handling a request. It includes both the request data, and a reference to the server. You also use it to build and send the response.
• Cookie
  Represents a Cookie
• Header
  Http header. Has a name and a value.
• Query
  Collection of query parameters. Can be made from the query string of a URL, or the body of a POST request. Similar to crate::header::Headers.
• Request
  Http Request
• Response
  Http Response
• Server
  Defines a server.
• SetCookie
  Represents a Set-Cookie header. Has more information than a normal Cookie (e.g. max-age, domain, path, secure).

Enums

• Content
  Common MIME types for HTTP responses. Used with the crate::Context::content and crate::Response::content methods.
• Error
  A generic error type for afire. Contains variants for Startup, Stream, Handle, Parse, IO and Miscellaneous errors.
• HeaderName
  HTTP header names.
• Method
  HTTP Methods.
• Status
  HTTP status codes.

Traits

• Middleware
  Trait used to implement Middleware, which is code that runs before and after the routes - potentially modifying the request and response. You can use Middleware to Log Requests, Ratelimit Requests, add Analytics, etc.