Skip to main content

Topic

Struct Topic 

Source
pub struct Topic<T: 'static> { /* private fields */ }
Expand description

Type-safe event topic.

T is the payload type associated with the topic. Two topics are equal only when both the topic name and payload type match.

Implementations§

Source§

impl<T: 'static> Topic<T>

Source

pub fn try_new(name: impl Into<String>) -> EventBusResult<Self>

Creates a topic after validating its name.

§Parameters
  • name: Non-blank topic name.
§Returns

A type-safe topic bound to T.

§Errors

Returns EventBusError::InvalidArgument when name is blank.

Source

pub fn name(&self) -> &str

Returns the topic name.

§Returns

The immutable topic name.

Source

pub fn payload_type_id(&self) -> TypeId

Returns the payload TypeId.

§Returns

Type identifier for payload T.

Source

pub fn payload_type_name(&self) -> &'static str

Returns the Rust payload type name.

§Returns

Fully qualified payload type name.

Source

pub fn key(&self) -> TopicKey

Returns a type-erased key for internal maps.

§Returns

A key containing the topic name and payload type.

Trait Implementations§

Source§

impl<T: 'static> Clone for Topic<T>

Source§

fn clone(&self) -> Self

Clones the topic metadata without requiring T: Clone.

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + 'static> Debug for Topic<T>

Source§

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

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

impl<T: 'static> Display for Topic<T>

Source§

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

Formats the topic as <payload_type>.<topic_name>.

Source§

impl<T: 'static> Hash for Topic<T>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Hashes topic name and payload type.

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: 'static> PartialEq for Topic<T>

Source§

fn eq(&self, other: &Self) -> bool

Compares topic name and payload type.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: 'static> Eq for Topic<T>

Auto Trait Implementations§

§

impl<T> Freeze for Topic<T>

§

impl<T> RefUnwindSafe for Topic<T>

§

impl<T> Send for Topic<T>

§

impl<T> Sync for Topic<T>

§

impl<T> Unpin for Topic<T>

§

impl<T> UnsafeUnpin for Topic<T>

§

impl<T> UnwindSafe for Topic<T>

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

Source§

impl<T> IntoValueDefault<T> for T

Source§

fn into_value_default(self) -> T

Converts this argument into the default value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.