Skip to main content

Crate photon_backend_nats

Crate photon_backend_nats 

Source
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

Performance methodology: photon-bench/PERFORMANCE_STUDY.md.

§Topic mapping (NATS)

  • Subject: photon.{topic} when stream_shards = 1; photon-s.{shard}.{topic} when sharded.
  • JetStream stream: default photon with photon.>; sharded mode uses photon-0…photon-(K-1).
  • Checkpoints: KV bucket photon-checkpoints (skipped when ReplayCursor::TailOnly).
  • Replay: ReplayCursor::StreamSeq uses JetStream stream sequence; ReplayCursor::TailOnly tails live only.

Re-exports§

pub use stream_shard::STREAM_SHARDS_ENV;

Modules§

stream_shard
JetStream stream shard routing (distinct from Photon virtual shard topic keys).

Structs§

NatsConfig
Resolved NATS adapter settings (no env lookups at append time).
NatsStoragePort
NATS JetStream-backed storage port.
NatsStoragePortBuilder
Builder for super::port::NatsStoragePort.

Enums§

ReplayCursor
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 JetStream stream retention.
STREAM_ENV
Environment variable for JetStream stream 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.