Module prelude

The prelude for common web application utilities.

This should contains the most commonly used items in std, [http], log, and bytes. It also exports all the items in crate.

Modules

• bytes
  Provides abstractions for working with bytes.
• chars
  Common characters expressed as a single byte each, according to UTF-8.
• compact_str

  compact_str

  A memory efficient string type that can store up to 24* bytes on the stack.

• fmt
  Utilities for formatting and printing Strings.
• header
  HTTP header types
• io
  Traits, helpers, and type definitions for core I/O functionality.
• net
  Networking primitives for TCP/UDP communication.
• str
  Utilities for the str primitive type.
• uri
  URI component of request and response lines

Macros

• build_bytes
  Convenience macro to create a Bytes from multiple &[u8] sources.
• debug
  Logs a message at the debug level.
• error
  Logs a message at the error level.
• format_compact
  Creates a CompactString using interpolation of runtime expressions.
• info
  Logs a message at the info level.
• log
  The standard logging macro.
• trace
  Logs a message at the trace level.
• warn
  Logs a message at the warn level.

Structs

• Arc
  A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
• Bytes
  A cheaply cloneable and sliceable chunk of contiguous memory.
• BytesMut
  A unique reference to a contiguous slice of memory.
• CompactString
  A CompactString is a compact string type that can be used almost anywhere a String or str can be used.
• Duration
  A Duration type to represent a span of time, typically used for system timeouts.
• Formatter
  Configuration for formatting.
• HashMap
  A hash map implemented with quadratic probing and SIMD lookup.
• HeaderMap
  A set of HTTP headers
• HeaderName
  Represents an HTTP header field name
• HeaderValue
  Represents an HTTP header field value.
• Instant
  A measurement of a monotonically nondecreasing clock. Opaque and useful only with Duration.
• Method
  The Request Method (VERB)
• Path
  A slice of a path (akin to str).
• PathBuf
  An owned, mutable path (akin to String).
• Request
  Represents an HTTP request.
• Response
  Represents an HTTP response
• StatusCode
  An HTTP status code (status-code in RFC 7230 et al.).
• Uri
  The URI component of a request.
• Version
  Represents a version of the HTTP spec.
• WriteableBytes
  A writeable Bytes.

Enums

• Cow
  A clone-on-write smart pointer.
• IpAddr
  An IP address, either IPv4 or IPv6.
• SocketAddr
  An internet socket address, either IPv4 or IPv6.

Traits

• AsCleanDebug
  Trait to enable .as_clean to get a CleanDebug for the variable.
• BufRead
  A BufRead is a type of Reader which has an internal buffer, allowing it to perform extra ways of reading.
• Debug
  ? formatting.
• Display
  Format trait for an empty format, {}.
• Ord
  Trait for types that form a total order.
• PartialOrd
  Trait for types that form a partial order.
• Read
  The Read trait allows for reading bytes from a source.
• Seek
  The Seek trait provides a cursor which can be moved within a stream of bytes.
• ToCompactString
  A trait for converting a value to a CompactString.
• TryFrom
  Simple and safe type conversions that may fail in a controlled way under some circumstances. It is the reciprocal of TryInto.
• Write
  A trait for objects which are byte-oriented sinks.

Derive Macros

• Debug
  Derive macro generating an impl of the trait Debug.
• Ord
  Derive macro generating an impl of the trait Ord. The behavior of this macro is described in detail here.
• PartialOrd
  Derive macro generating an impl of the trait PartialOrd. The behavior of this macro is described in detail here.