Struct Topic 

pub struct Topic(/* private fields */);

Identifier for a gossip- or sync topic.

A topic identifier is required when subscribing or publishing to a stream.

Topics usually describe concrete data which nodes want to exchange over, for example a document id or chat group id and so forth. Applications usually want to share topics via a secure side channel.

WARNING: Sensitive topics have to be treated like secret values and generated using a cryptographically secure pseudorandom number generator (CSPRNG). Otherwise they can be easily guessed by third parties or leaked during discovery.

Implementations

impl Topic

pub fn random() -> Self

pub fn from_rng<R: Rng>(rng: &mut R) -> Self

pub fn from_bytes(&self, bytes: &[u8]) -> Result<Self, TopicError>

pub fn as_bytes(&self) -> &[u8; 32]

pub fn to_bytes(self) -> [u8; 32]

pub fn to_hex(&self) -> String

Trait Implementations

impl Clone for Topic

fn clone(&self) -> Topic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Topic

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

Formats the value using the given formatter.

impl Default for Topic

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Topic

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Topic

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

Formats the value using the given formatter.

impl From<[u8; 32]> for Topic

fn from(topic: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<Hash> for Topic

fn from(value: Hash) -> Self

Converts to this type from the input type.

impl From<Topic> for [u8; 32]

fn from(topic: Topic) -> Self

Converts to this type from the input type.

impl From<Topic> for Hash

fn from(topic: Topic) -> Self

Converts to this type from the input type.

impl From<VerifyingKey> for Topic

fn from(value: VerifyingKey) -> Self

Converts to this type from the input type.

impl FromStr for Topic

type Err = TopicError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Topic

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Topic

fn cmp(&self, other: &Topic) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Topic

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Topic

fn partial_cmp(&self, other: &Topic) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Topic

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Topic

type Error = TopicError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Topic

type Error = TopicError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Topic

impl Eq for Topic

impl StructuralPartialEq for Topic