Feature flags of Poem crate // Lib.rs

Cargo Features

[dependencies]
poem = { version = "3.1.4", default-features = false, features = ["server", "websocket", "multipart", "rustls", "native-tls", "openssl-tls", "sse", "static-files", "compression", "tower-compat", "cookie", "session", "redis-session", "opentelemetry", "prometheus", "tempfile", "csrf", "i18n", "acme", "acme-native-roots", "acme-webpki-roots", "acme-base", "embed", "xml", "yaml", "requestid", "sonic-rs", "test", "tokio-metrics", "anyhow", "eyre06"] }

default = server

The server feature is set by default whenever poem is added without default-features = false somewhere in the dependency tree.

server default acme-base? native-tls? openssl-tls? rustls?

Enables server of hyper, rt of tokio

Affects poem::listener…

websocket = base64, tokio-tungstenite

Enables rt of tokio

tokio:
Includes basic task execution capabilities

Affects error::WebSocketError, web::websocket…

multipart = multer

Affects error::ParseMultipartError…

rustls acme-base? = rustls-pemfile, server, tokio-rustls

Affects listener::AcceptorExt.rustls, listener::Listener.rustls, tls::IntoTlsConfigStream…

native-tls = server, tokio-native-tls

Affects listener::AcceptorExt.native_tls, listener::Listener.native_tls, tls::IntoTlsConfigStream…

openssl-tls = openssl, server, tokio-openssl

Affects listener::AcceptorExt.openssl_tls, listener::Listener.openssl_tls, tls::IntoTlsConfigStream…

sse test? = tokio-stream

Affects web::sse…

static-files = httpdate, mime_guess

Enables fs and io-util of tokio

compression = async-compression

tower-compat = tower

Enables rt of tokio

cookie csrf? session? = chrono, libcookie, time

Affects error::ParseCookieError, web::cookie…

session redis-session? = base64, cookie, priority-queue, rand

Enables rt of tokio

Affects poem::session…

redis-session = redis, session

Affects error::RedisSessionError…

opentelemetry = libopentelemetry, opentelemetry-http, opentelemetry-semantic-conventions

prometheus = libopentelemetry, libprometheus, opentelemetry-prometheus

tempfile = libtempfile

Enables fs of tokio

csrf = base64, cookie, libcsrf

i18n = fluent, fluent-langneg, fluent-syntax, intl-memoizer, unic-langid

Affects error::I18NError, poem::i18n…

acme = acme-native-roots

acme-native-roots acme? = acme-base

Enables rustls-tls-native-roots of reqwest

acme-webpki-roots = acme-base

Enables rustls-tls-webpki-roots of reqwest

acme-base acme-native-roots? acme-webpki-roots? = base64, chrono, rcgen, reqwest, ring, rustls, server, x509-parser

Affects listener::acme, listener::Listener.acme…

embed = hex, mime_guess, rust-embed

xml = quick-xml

Affects error::ParseXmlError…

yaml = serde_yaml

Affects error::ParseYamlError…

requestid

Enables uuid

sonic-rs

Enables sonic-rs

test = sse, sse-codec

Enables compat of tokio-util

Affects poem::test…

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

multer multipart?

Enables multer