Expand description
NATS JetStream StoragePort for distributed Photon delivery.
Wraps JetStream consumer groups, checkpoint persistence, and stream sharding behind the shared
storage contract. Enable via the nats feature on the
photon public crate.
Connection and stream options: NatsConfig and NatsStoragePortBuilder
(builder methods + env fallbacks documented on the builder).
Wire with PhotonBuilder::storage_port
after NatsStoragePortBuilder::build.
§Entry points
NatsStoragePort—JetStreamstorage adapterNatsConfig/NatsStoragePortBuilder— connection and stream optionsnats_url_from_env— resolve broker URL from environment
Performance methodology: photon-bench/PERFORMANCE_STUDY.md.
§Topic mapping (NATS)
- Subject:
photon.{topic}whenstream_shards = 1;photon-s.{shard}.{topic}when sharded. JetStreamstream: defaultphotonwithphoton.>; sharded mode usesphoton-0…photon-(K-1).- Checkpoints: KV bucket
photon-checkpoints(skipped whenReplayCursor::TailOnly). - Replay:
ReplayCursor::StreamSequsesJetStreamstream sequence;ReplayCursor::TailOnlytails live only.
Re-exports§
pub use stream_shard::STREAM_SHARDS_ENV;
Modules§
- stream_
shard JetStreamstream shard routing (distinct from Photon virtual shard topic keys).
Structs§
- Nats
Config - Resolved NATS adapter settings (no env lookups at append time).
- Nats
Storage Port - NATS JetStream-backed storage port.
- Nats
Storage Port Builder - Builder for
super::port::NatsStoragePort.
Enums§
- Replay
Cursor - How durable replay and checkpoints map to
JetStream.
Constants§
- CREDS_
ENV - Environment variable for NATS credentials file path (JWT +
NKey.creds). - MAX_
INFLIGHT_ ENV - Environment variable for max in-flight publishes per port.
- REPLAY_
CURSOR_ ENV - Environment variable for replay cursor mode.
- REPLICAS_
ENV - Environment variable for stream replica count.
- RETENTION_
ENV - Environment variable for
JetStreamstream retention. - STREAM_
ENV - Environment variable for
JetStreamstream name. - SYNC_
ACK_ ENV - Environment variable for synchronous publish ack (
1/0). - URL_ENV
- Environment variable for NATS server URL.
Functions§
- deliver_
subject_ for - Fixed deliver subject for a durable consumer name.
- durable_
consumer_ name - Build a JetStream-safe durable consumer name for a keyed subscription.
- nats_
url_ from_ env - Read NATS URL from the environment.