Skip to main content

BusClient

Struct BusClient 

Source
pub struct BusClient { /* private fields */ }
Expand description

A module’s current connection and the task that maintains its credentials.

Implementations§

Source§

impl BusClient

Source

pub async fn connect( subc: Arc<SubcConsumer>, opts: BusClientOptions, ) -> Result<Self>

Issues a credential for the module identity that the subc daemon authenticates from the module’s launch nonce.

Source

pub fn connection(&self) -> NatsConnection

Returns a snapshot. A re-issue does not change an already held snapshot.

Source

pub fn connection_changes(&self) -> Receiver<u64>

Changes only after a replacement connection with a new inbox is ready. Reopen raw subscriptions and durable pulls when this receiver changes; EventReader handles its own rebinding automatically.

If credential maintenance can no longer renew or re-issue, its task ends and drops the sender. The receiver’s changed() then returns Err once any unseen change has been consumed. Reconnect with BusClient::connect or report the module as degraded when the change stream closes.

Source

pub fn acct(&self) -> &str

Source

pub async fn event_reader(&self, durable: &str) -> Result<EventReader>

Attaches to an existing EVENT durable owned by this module.

ck-bus provisions durables; this method never creates or changes one. The name must follow bus-naming’s m_{module}[_suffix] owner rule. The reader rebinds automatically after credential re-issue. Nothing is acknowledged automatically: commit your own transaction before ack().

Source

pub fn bucket(&self, owner_module: &str, bucket: &str) -> Result<Bucket>

Opens a declared module bucket for its owner or a declared reader. Does not provision buckets or change their limits.

Source

pub async fn publish_event( &self, event: &str, version: u32, qualifier: Option<&str>, msg_id: &str, body: impl Into<Bytes>, ) -> Result<PublishReceipt>

Stores an event using the fact’s own id for JetStream deduplication.

Event bodies carry ids, counters and enums, not large content. Bodies larger than 4 KiB are refused; retrieve large content through its owner’s own call instead. Inline bodies reach every reader whose durable matches the subject, with no per-reader visibility check; reserve them for pointers and facts every declared reader may see. Flow triggers must use Self::publish_claim_check, the cortexkit_bus_trait::Stream::publish claim-check path (empty payload plus content digest), with the publisher serving the body under the reading flow’s own scope to check which agent may see it. The flow engine refuses inline trigger bodies.

Source

pub async fn publish_claim_check( &self, event: &str, version: u32, qualifier: Option<&str>, msg_id: &str, digest: ContentDigest, headers: Headers, ) -> Result<PublishReceipt>

Publishes an empty-payload claim check carrying the body’s content digest. Store the body before publishing and serve it through the publisher’s own events_get query under the reading flow’s scope. This is the event shape for triggering flows; inline bodies cannot be used as flow triggers. The NATS codec writes Nats-Msg-Id and Ck-Content-Digest and refuses caller headers spelling either reserved name, including case variants.

Source

pub async fn live_hint( &self, kind: &str, version: u32, body: impl Into<Bytes>, ) -> Result<()>

Publishes an ephemeral, versioned hint, not a stored fact.

Trait Implementations§

Source§

impl Drop for BusClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more