Reference

The full API reference for shove is auto-generated rustdoc on docs.rs/shove.

Headline types

• Broker — generic entry point parameterized on the backend marker
• Publisher — typed publish API
• TopologyDeclarer — idempotent topology setup
• ConsumerSupervisor — N-poller fan-out (SQS, all backends)
• ConsumerGroup — coordinated min/max-bounded groups
• BroadcastSubscriber — ephemeral per-instance fan-out, gated by HasBroadcast
• SupervisorOutcome — shutdown result with exit_code()

Core enums and traits

• Outcome — Ack, Retry, Reject, Defer
• MessageHandler — handler trait, parameterized on Topic
• MessageHandlerExt — fluent helpers (.audited(...))
• Topic, SequencedTopic — topic traits
• TopologyBuilder — .hold_queue, .sequenced, .routing_shards, .dlq, .for_consumer_group, .broadcast
• BatchFailure — which records a partial publish_batch left behind
• ConsumerOptions — per-consumer tuning
• Codec — per-topic wire encoding (JsonCodec, ProtobufCodec, SbeCodec, RawBytesCodec)
• SbeFrame, SbeMessage — zero-copy SBE wire frames (sbe feature)
• shove::env — prefix-scoped from_env() constructors for the tuning knobs (env-config feature)

Per-backend modules

• shove::rabbitmq — RabbitMQ backend
• shove::sns — AWS SNS+SQS backend
• shove::nats — NATS JetStream backend
• shove::kafka — Apache Kafka backend
• shove::redis — Redis/Valkey Streams backend
• shove::inmemory — in-process backend

Docs on this site follow main. For pinned versions, use the version dropdown on docs.rs.