Crate worker

Re-exports

pub use worker_kv as kv;

pub use crate::durable::*;

Durable Objects provide low-latency coordination and consistent storage for the Workers platform. A given namespace can support essentially unlimited Durable Objects, with each Object having access to a transactional, key-value storage API.

ws_events

Macros

console_debug

When debugging your Worker via wrangler dev, wrangler tail, or from the Workers Dashboard, anything passed to this macro will be printed to the terminal or written to the console.

console_error

When debugging your Worker via wrangler dev, wrangler tail, or from the Workers Dashboard, anything passed to this macro will be printed to the terminal or written to the console.

console_log

When debugging your Worker via wrangler dev, wrangler tail, or from the Workers Dashboard, anything passed to this macro will be printed to the terminal or written to the console.

console_warn

When debugging your Worker via wrangler dev, wrangler tail, or from the Workers Dashboard, anything passed to this macro will be printed to the terminal or written to the console.

Structs

AbortController

An interface that allows you to abort in-flight Fetch requests.

AbortSignal

An interface representing a signal that can be passed to cancellable operations, primarily a Fetch request.

ByteStream

Cache

Provides access to the Cache API. Because match is a reserved keyword in Rust, the match method has been renamed to get.

Cf

In addition to the methods on the Request struct, the Cf struct on an inbound Request contains information about the request provided by Cloudflare’s edge.

CfProperties

https://developers.cloudflare.com/workers/runtime-apis/request#requestinitcfproperties

CloseEvent

Wrapper/Utility struct for the web_sys::CloseEvent

Context

A context bound to a fetch event.

Cors

Cors struct, holding cors configuration

Date

The equivalent to a JavaScript Date Object.

Delay

A Future for asynchronously waiting.

Env

Env contains any bindings you have associated with the Worker when you uploaded it.

EventStream

A Stream that yields WebsocketEvents emitted by the inner WebSocket. The stream is guranteed to always yield a WebsocketEvent::Close as the final non-none item.

File

A File representation used with FormData.

FormData

A FormData representation of the request body, providing access to form encoded fields and files.

Headers

A Headers representation used in Request and Response objects.

MessageEvent

Wrapper/Utility struct for the web_sys::MessageEvent

MinifyConfig

Configuration options for Cloudflare’s minification features: https://www.cloudflare.com/website-optimization/

Request

A Request representation for handling incoming and creating outbound HTTP requests.

RequestInit

Optional options struct that contains settings to apply to the Request.

Response

A Response representation for working with or returning a response to a Request.

RouteContext

Container for a route’s parsed parameters, data, and environment bindings from the Runtime (such as KV Stores, Durable Objects, Variables, and Secrets).

RouteParams

Represents the URL parameters parsed from the path, e.g. a route with “/user/:id” pattern would contain a single “id” key.

Router

A path-based HTTP router supporting exact-match or wildcard placeholders and shared data.

A parsed URL record.

Wrapper struct for underlying worker-sys WebSocket

WebSocketPair