Skip to main content

TopicDescriptor

Struct TopicDescriptor 

Source
pub struct TopicDescriptor {
    pub topic_name: &'static str,
    pub keyed_by: Option<&'static str>,
    pub schema_json: &'static str,
    pub delivery: DeliveryMode,
    pub shard_config: Option<ShardConfig>,
}
Expand description

Descriptor for a registered topic (from #[photon::topic] macro).

Used for runtime lookup and schema metadata.

Fields§

§topic_name: &'static str

Stable topic name (e.g., “user.notifications”).

§keyed_by: Option<&'static str>

Optional key field name.

§schema_json: &'static str

Reserved JSON schema metadata placeholder.

Currently always "{}" from #[photon::topic]. Not validated at publish time; do not infer schema enforcement from this field.

§delivery: DeliveryMode

Publish routing mode (broadcast default).

§shard_config: Option<ShardConfig>

Virtual shard settings when DeliveryMode::ConsumerGroup.

Implementations§

Source§

impl TopicDescriptor

Source

pub const fn new( topic_name: &'static str, keyed_by: Option<&'static str>, schema_json: &'static str, ) -> Self

Create a broadcast topic descriptor (default delivery mode).

Source

pub const fn group( topic_name: &'static str, shard_count: u32, shard_by: Option<&'static str>, schema_json: &'static str, ) -> Self

Create a consumer-group topic with virtual shard routing.

Source

pub fn is_consumer_group(&self) -> bool

Whether publishes route to virtual shard streams.

Source

pub fn schema_value(&self) -> Option<Value>

Get schema as parsed JSON.

Trait Implementations§

Source§

impl Clone for TopicDescriptor

Source§

fn clone(&self) -> TopicDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Collect for TopicDescriptor

Source§

impl Debug for TopicDescriptor

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Registrable for TopicDescriptor

Source§

fn registry_key(&self) -> &str

Return the unique lookup key used by the registry.

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.