Crate ryde

source ·

Re-exports§

Modules§

  • HTTP body utilities.
  • Extractor for getting connection information from a client.
  • Cookie parsing and cookie jar management.
  • Generic data structure deserialization framework.
  • Error handling model and utilities
  • Types and traits for extracting data from requests.
  • Async functions that can be used to handle requests.
  • A general purpose library of common HTTP types
  • Traits, helpers, and type definitions for asynchronous I/O functionality.
  • Utilities for writing middleware
  • Extractor that parses multipart/form-data requests commonly used with file uploads.
  • TCP/UDP/Unix bindings for tokio.
  • Extractor that will get captures from the URL and parse them using serde.
  • Rejection response types.
  • Types and traits for generating responses.
  • Routing between Services and handlers.
  • The Tokio runtime.
  • Generic data structure serialization framework.
  • Serve services.
  • Server-Sent Events (SSE) responses.
  • Due to the Stream trait’s inclusion in std landing later than Tokio’s 1.0 release, most of the Tokio stream utilities have been moved into the tokio-stream crate.
  • Synchronization primitives for use in asynchronous contexts.
  • Asynchronous green-threads.
  • Utilities for tracking time.

Macros§

Structs§

  • Append headers to a response.
  • Cache results of other extractors.
  • Extractor for getting connection information produced by a Connected.
  • A handle to call functions in background thread.
  • Representation of an HTTP cookie.
  • Extractor that grabs cookies from the request and manages the jar.
  • Layer for configuring the default request body limit.
  • A drain iterator for HeaderMap.
  • An IntoResponse-based error type
  • Extractor and response for extensions.
  • URL encoded extractor and response.
  • A view to all values stored in a single entry.
  • A set of HTTP headers
  • Represents an HTTP header field name
  • Represents an HTTP header field value.
  • Extractor that resolves the hostname of the request.
  • An owning iterator over the entries of a HeaderMap.
  • A possible error when converting a HeaderName from another type.
  • A possible error when converting a HeaderValue from a string or byte slice.
  • HeaderMap entry iterator.
  • HeaderMap mutable entry iterator
  • JSON Extractor / Response.
  • An iterator over HeaderMap keys.
  • Access the path in the router that matches the request.
  • Extractor that parses multipart/form-data requests (commonly used with file uploads).
  • Access the path the matched the route is nested at.
  • A view into a single occupied location in a HeaderMap.
  • Extractor that extracts path arguments the same way as Path, except if there aren’t any.
  • Extractor that gets the original request URI regardless of nesting.
  • Extractor that will get captures from the URL and parse them using serde.
  • Extractor that deserializes query strings into some type.
  • Extractor that extracts raw form requests.
  • Extractor that will get captures from the URL without deserializing them.
  • Extractor that extracts the raw query string, without parsing it.
  • Response that redirects the request to another location.
  • Parts of a response.
  • The router type for composing handlers and services.
  • An SSE response
  • Extractor for state.
  • A possible error when converting a HeaderValue to a string representation.
  • Extractor and response that works with typed header values from headers.
  • The URI component of a request.
  • A view into a single empty location in a HeaderMap.
  • An drain iterator of all values associated with a single header name.
  • An iterator of all values associated with a single header name.
  • A mutable iterator of all values associated with a single header name.
  • HeaderMap value iterator.
  • HeaderMap mutable value iterator
  • Extractor for customizing extractor rejections

Enums§

  • A view into a single location in a HeaderMap, which may be vacant or occupied.

Constants§

  • Advertises which content types the client is able to understand.
  • Advertises which character set the client is able to understand.
  • Advertises which content encoding the client is able to understand.
  • Advertises which languages the client is able to understand.
  • Marker used by the server to advertise partial request support.
  • Preflight response indicating if the response to the request can be exposed to the page.
  • Preflight response indicating permitted HTTP headers.
  • Preflight header response indicating permitted access methods.
  • Indicates whether the response can be shared with resources with the given origin.
  • Indicates which headers can be exposed as part of the response by listing their names.
  • Indicates how long the results of a preflight request can be cached.
  • Informs the server which HTTP headers will be used when an actual request is made.
  • Informs the server know which HTTP method will be used when the actual request is made.
  • Indicates the time in seconds the object has been in a proxy cache.
  • Lists the set of methods support by a resource.
  • Advertises the availability of alternate services to clients.
  • Contains the credentials to authenticate a user agent with a server.
  • Specifies directives for caching mechanisms in both requests and responses.
  • Indicates how caches have handled a response and its corresponding request.
  • Specifies directives that allow origin servers to control the behavior of CDN caches interposed between them and clients separately from other caches that might handle the response.
  • Controls whether or not the network connection stays open after the current transaction finishes.
  • Indicates if the content is expected to be displayed inline.
  • Used to compress the media-type.
  • Used to describe the languages intended for the audience.
  • Indicates the size of the entity-body.
  • Indicates an alternate location for the returned data.
  • Indicates where in a full body message a partial message belongs.
  • Allows controlling resources the user agent is allowed to load for a given page.
  • Allows experimenting with policies by monitoring their effects.
  • Used to indicate the media type of the resource.
  • Contains stored HTTP cookies previously sent by the server with the Set-Cookie header.
  • Contains the date and time at which the message was originated.
  • Indicates the client’s tracking preference.
  • Identifier for a specific version of a resource.
  • Indicates expectations that need to be fulfilled by the server in order to properly handle the request.
  • Contains the date/time after which the response is considered stale.
  • Contains information from the client-facing side of proxy servers that is altered or lost when a proxy is involved in the path of the request.
  • Contains an Internet email address for a human user who controls the requesting user agent.
  • Specifies the domain name of the server and (optionally) the TCP port number on which the server is listening.
  • Makes a request conditional based on the E-Tag.
  • Makes a request conditional based on the modification date.
  • Makes a request conditional based on the E-Tag.
  • Makes a request conditional based on range.
  • Makes the request conditional based on the last modification date.
  • Content-Types that are acceptable for the response.
  • Allows the server to point an interested client to another resource containing metadata about the requested resource.
  • Indicates the URL to redirect a page to.
  • Indicates the max number of intermediaries the request should be sent through.
  • Indicates where a fetch originates from.
  • HTTP/1.0 header usually used for backwards compatibility.
  • Defines the authentication method that should be used to gain access to a proxy.
  • Contains the credentials to authenticate a user agent to a proxy server.
  • Associates a specific cryptographic public key with a certain server.
  • Sends reports of pinning violation to the report-uri specified in the header.
  • Indicates the part of a document that the server should return.
  • Contains the address of the previous web page from which a link to the currently requested page was followed.
  • Governs which referrer information should be included with requests made.
  • Informs the web browser that the current page or frame should be refreshed.
  • The Retry-After response HTTP header indicates how long the user agent should wait before making a follow-up request. There are two main cases this header is used:
  • The |Sec-WebSocket-Accept| header field is used in the WebSocket opening handshake. It is sent from the server to the client to confirm that the server is willing to initiate the WebSocket connection.
  • The |Sec-WebSocket-Extensions| header field is used in the WebSocket opening handshake. It is initially sent from the client to the server, and then subsequently sent from the server to the client, to agree on a set of protocol-level extensions to use for the duration of the connection.
  • The |Sec-WebSocket-Key| header field is used in the WebSocket opening handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket opening handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g., HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.
  • The |Sec-WebSocket-Protocol| header field is used in the WebSocket opening handshake. It is sent from the client to the server and back from the server to the client to confirm the subprotocol of the connection. This enables scripts to both select a subprotocol and be sure that the server agreed to serve that subprotocol.
  • The |Sec-WebSocket-Version| header field is used in the WebSocket opening handshake. It is sent from the client to the server to indicate the protocol version of the connection. This enables servers to correctly interpret the opening handshake and subsequent data being sent from the data, and close the connection if the server cannot interpret that data in a safe manner.
  • Contains information about the software used by the origin server to handle the request.
  • Used to send cookies from the server to the user agent.
  • Tells the client to communicate with HTTPS instead of using HTTP.
  • Informs the server of transfer encodings willing to be accepted as part of the response.
  • Allows the sender to include additional fields at the end of chunked messages.
  • Specifies the form of encoding used to safely transfer the entity to the client.
  • Used as part of the exchange to upgrade the protocol.
  • Sends a signal to the server expressing the client’s preference for an encrypted and authenticated response.
  • Contains a string that allows identifying the requesting client’s software.
  • Determines how to match future requests with cached responses.
  • Added by proxies to track routing.
  • General HTTP header contains information about possible problems with the status of the message.
  • Defines the authentication method that should be used to gain access to a resource.
  • Marker used by the server to indicate that the MIME types advertised in the content-type headers should not be changed and be followed.
  • Controls DNS prefetching.
  • Indicates whether or not a browser should be allowed to render a page in a frame.
  • Stop pages from loading when an XSS attack is detected.

Traits§

  • A marker trait used to identify values that can be used as search keys to a HeaderMap.
  • A data structure that can be deserialized from any data format supported by Serde.
  • A data format that can deserialize any data structure supported by Serde.
  • Format trait for an empty format, {}.
  • Used to do reference-to-value conversions thus not consuming the input value.
  • Types that can be created from requests.
  • Types that can be created from request parts.
  • A marker trait used to identify values that can be used as insert keys to a HeaderMap.
  • Trait for generating responses.
  • Trait for adding headers and extensions to a response.
  • Extension trait that adds additional methods to Request.
  • Extension trait that adds additional methods to Parts.
  • A data structure that can be serialized into any data format supported by Serde.
  • A data format that can serialize any data structure supported by Serde.
  • Extension trait that adds additional methods to any Service.

Functions§

Type Aliases§

Attribute Macros§

  • Generates better error messages when applied handler functions.
  • Marks async function to be executed by the selected runtime. This macro helps set up a Runtime without requiring the user to use Runtime or Builder directly.
  • Marks async function to be executed by runtime, suitable to test environment. This macro helps set up a Runtime without requiring the user to use Runtime or Builder directly.

Derive Macros§