Module kvarn::prelude

The Kvarn Prelude

The purpose of this module is to simplify, make modules dependencies obvious, and keep consistency in the development of the Kvarn web server.

Other specialised preludes can be found as modules, including

• a fs prelude
• a networking prelude
• an internals prelude
• a threading prelude

Re-exports

pub use crate::application;

pub use crate::comprash;

pub use crate::cors;

pub use crate::csp;

pub use crate::encryption;

pub use crate::extensions;

pub use crate::host;

pub use crate::limiting;

pub use crate::vary;

pub use kvarn_async as async_bits;

pub use kvarn_utils as utils;

pub use comprash::UriKey;

pub use cors::AllowList as CorsAllowList;

pub use cors::Cors;

pub use csp::Csp;

pub use csp::Rule as CspRule;

pub use csp::Value as CspValue;

pub use csp::ValueSet as CspValueSet;

pub use error::default as default_error;

pub use error::default_response as default_error_response;

pub use extensions::Package;

pub use extensions::Post;

pub use extensions::Prepare;

pub use extensions::Present;

pub use extensions::Prime;

pub use extensions::ResponsePipeFuture;

pub use host::Collection as HostCollection;

pub use host::Host;

pub use read::file as read_file;

pub use read::file_cached as read_file_cached;

pub use shutdown::AcceptAction;

pub use shutdown::AcceptManager;

pub use crate::*;

Modules

bytes

Provides abstractions for working with bytes.

chars

Common characters expressed as a single byte each, according to UTF-8.

chrono

Prelude: time

cmp

Utilities for comparing and ordering values.

extensions

Parsing utilities and constants for Kvarn extensions.

fmt

Utilities for formatting and printing Strings.

fs

Prelude: file system

header

HTTP header types

internals

Prelude: internal

io

Traits, helpers, and type definitions for core I/O functionality.

net

Networking primitives for TCP/UDP communication.

networking

Prelude: networking

parse

General parsing complying to the HTTP standards.

str

Utilities for the str primitive type.

threading

Prelude: internal

uri

URI component of request and response lines

utils

Utility functions for web application development.

Macros

Debug

Derive macro generating an impl of the trait Debug.

Ord

Derive macro generating an impl of the trait Ord.

PartialOrd

Derive macro generating an impl of the trait PartialOrd.

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.

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.

Context

The context of an asynchronous task.

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)

Mutex

An asynchronous Mutex-like type.

Path

A slice of a path (akin to str).

PathBuf

An owned, mutable path (akin to String).

Pin

A pinned pointer.

ReadBuf

A wrapper around a byte buffer that is incrementally filled and initialized.

Request

Represents an HTTP request.

Response

Represents an HTTP response

RwLock

An asynchronous reader-writer lock.

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.

Poll

Indicates whether a value is available or if the current task has been scheduled to receive a wakeup instead.

SanitizeError

An error regarding the sanitization of a request.

SocketAddr

An internet socket address, either IPv4 or IPv6.

Constants

AMPERSAND

&

BANG

!

COLON

:

CR

Carrage return

DOLLAR

$

ESCAPE

\

FORWARD_SLASH

/

LF

Line feed

L_SQ_BRACKET

[

PERIOD

.

PIPE

|

QUOTATION

"

R_SQ_BRACKET

]

R_TAG

>

SPACE

TAB

Tab

Traits

AsCleanDebug

Trait to enable .as_clean to get a CleanDebug for the variable.

AsyncRead

Reads bytes from a source.

AsyncReadExtio-util

Reads bytes from a source.

AsyncWrite

Writes bytes asynchronously.

AsyncWriteExtio-util

Writes bytes to a sink.

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, {}.

Future

A future represents an asynchronous computation obtained by use of async.

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.

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.

Functions

ref_to_mut

Casts &T to *mut T for getting mutable access from a immutable reference.