Crate kvarn_utils

source · [−]

Expand description

Utility functions for web application development.

This includes

commonly used chars,
a build_bytes macro to create a Bytes from bytes slices with one allocation,
WriteableBytes to optimize performance when creating a new Bytes of unknown length,
hardcoded_error_body to get a hard-coded error response.
CleanDebug and it’s trait AsCleanDebug to get a Debug implementation wired to the item’s Display implementation.

Modules

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

Parsing utilities and constants for Kvarn extensions.

General parsing complying to the HTTP standards.

The prelude for common web application utilities.

Macros

Convenience macro to create a Bytes from multiple &[u8] sources.

Stringify $field on $self. This only returns the field name. This is constructed to make your IDE recognize the input as the actual field. This means renaming is applied to the string returned from this when you rename a field in your IDE.

Adds a $field to the std::fmt::DebugStruct, $f from $self.

fmt_field! but multiple.

Return stringified representation of $item. This uses similar techniques to ident_str!.

starts_with_any

Tests if the first arguments starts with any of the following.

Structs

Implements Debug from the Display implementation of value.

CriticalRequestComponents

Critical components from request to apply to response.

PresentArguments

The arguments and name of a single Present extension.

PresentArgumentsIter

An iterator of str for the arguments in PresentArguments

PresentExtensions

The Present extensions parsed from a file containing them.

PresentExtensionsIter

An iterator of PresentArguments from PresentExtensions

QuotedStrSplitIter

Iterator for quoted_str_split. Returns owned strings.

SuperUnsafePointer

Should only be used from within Kvarn! A super-unsafe pointer. Must be used with great care.

ValueQualitySet

A pair of a value string and a quality of said value.

A writeable Bytes.

Traits

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

Functions

empty_clone_request

Clones a Request, discarding the body.

empty_clone_response

Clones a Response, discarding the body.

encode_quoted_str

Encodes, to be decoded by quoted_str_split, src by appending to dest.

get_body_length_request

Gets the body length from the Request::headers of request.

get_body_length_response

Gets the body length of a response.

hardcoded_error_body

Get a hardcoded error message.

Checks the equality of value of name in headers and value. Value does not need to be all lowercase; the equality operation ignores the cases.

is_valid_header_value_byte

Checks byte if it’s a valid byte for HeaderValues.

Joins the items in iter with a separator using 1 allocation.

Parses a header with a value-quality list of pairs.

Makes a PathBuf using one allocation.

method_has_request_body

Does a request of type method have a body?

method_has_response_body

Does a response of type method have a body?

Decodes the URI encoding.

quoted_str_split

Shell-like splitting of s.

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

remove_all_headers

Removes all headers from headers with name.

Replaces the header name with new in headers.

replace_header_static

Replaces header name with new (a &’static str) in headers.

sanitize_request

Sanitizes request for unwanted data and returns critical components.

set_content_length

Sets the content-length of headers to len.

Splits a Response into a empty Response and it’s body.

Check if bytes starts with a valid Method.

Checks if bytes starts with a valid Version