[package]
edition = "2021"
rust-version = "1.85"
name = "ws-kit"
version = "1.0.0"
build = false
exclude = ["/target"]
autolib = false
autobins = false
autoexamples = false
autotests = false
autobenches = false
description = "Generic authenticated typed WebSocket: BroadcastHub, RoomManager, heartbeat, and token extraction for Axum"
readme = "README.md"
keywords = [
"websocket",
"realtime",
"axum",
"broadcast",
]
categories = [
"web-programming",
"asynchronous",
]
license = "MIT OR Apache-2.0"
repository = "https://github.com/WyattAu/ws-kit"
[package.metadata.docs.rs]
all-features = true
rustdoc-args = [
"--cfg",
"docsrs",
]
[package.metadata.layers]
tier = "L2"
[features]
axum = [
"dep:axum",
"dep:http",
]
compression = ["dep:flate2"]
default = ["axum"]
loom = []
metrics = ["dep:metrics"]
redis = [
"dep:redis",
"dep:futures-util",
]
tracing = []
[lib]
name = "ws_kit"
path = "src/lib.rs"
[[test]]
name = "config_matrix"
path = "tests/config_matrix.rs"
[[test]]
name = "integration"
path = "tests/integration.rs"
[[test]]
name = "redis_rooms"
path = "tests/redis_rooms.rs"
required-features = ["redis"]
[[test]]
name = "zero_alloc_frame_rx"
path = "tests/zero_alloc_frame_rx.rs"
[[bench]]
name = "broadcast_roundtrip"
path = "benches/broadcast_roundtrip.rs"
harness = false
[[bench]]
name = "compression_roundtrip"
path = "benches/compression_roundtrip.rs"
harness = false
required-features = ["compression"]
[[bench]]
name = "iai_hot_path"
path = "benches/iai_hot_path.rs"
harness = false
[[bench]]
name = "ws_bench"
path = "benches/ws_bench.rs"
harness = false
[dependencies.axum]
version = "0.8"
features = ["ws"]
optional = true
[dependencies.bytes]
version = "1"
features = ["serde"]
[dependencies.dashmap]
version = "6"
[dependencies.flate2]
version = "1"
features = ["rust_backend"]
optional = true
default-features = false
[dependencies.futures-util]
version = "0.3"
features = ["std"]
optional = true
default-features = false
[dependencies.http]
version = "1"
optional = true
[dependencies.metrics]
version = "0.24"
optional = true
[dependencies.redis]
version = "0.32"
features = ["tokio-comp"]
optional = true
default-features = false
[dependencies.serde]
version = "1"
features = ["derive"]
[dependencies.serde_json]
version = "1"
[dependencies.thiserror]
version = "2"
[dependencies.tokio]
version = "1"
features = [
"rt",
"rt-multi-thread",
"macros",
"sync",
"time",
]
[dev-dependencies.bytes]
version = "1"
[dev-dependencies.criterion]
version = "0.5"
features = ["html_reports"]
[dev-dependencies.iai-callgrind]
version = "0.16"
[dev-dependencies.proptest]
version = "1"
[dev-dependencies.tokio]
version = "1"
features = ["full"]
[target."cfg(loom)".dependencies.loom]
version = "0.7"
features = ["futures"]
[lints.clippy]
expect_used = "warn"
indexing_slicing = "deny"
panic = "deny"
unwrap_used = "deny"
[lints.rust.unexpected_cfgs]
level = "warn"
priority = 0
check-cfg = ["cfg(loom)"]