Skip to main content

PubsubMessage

Struct PubsubMessage 

Source
pub struct PubsubMessage {
    pub from: String,
    pub data: Vec<u8>,
    pub seqno: Vec<u8>,
    pub topic_ids: Vec<String>,
    pub topic: String,
}
Expand description

A message received from or published to a pubsub topic.

§Kubo Equivalent

Corresponds to the message format used in ipfs pubsub sub output. See core/commands/pubsub.go:pubsubSubCmd.

§Example

use ferripfs_network::PubsubMessage;

// Create a simple message with just sender, topic, and data
let msg = PubsubMessage::simple(
    "QmPeerID".to_string(),
    "my-topic".to_string(),
    b"Hello, world!".to_vec(),
);
assert_eq!(msg.topic, "my-topic");

// Or create a message with all fields
let msg_full = PubsubMessage::new(
    "QmPeerID".to_string(),
    b"Hello!".to_vec(),
    vec![1, 2, 3, 4],  // seqno
    vec!["my-topic".to_string()],  // topic_ids
    "my-topic".to_string(),
);
assert_eq!(msg_full.seqno, vec![1, 2, 3, 4]);

Fields§

§from: String

Peer ID of the message sender.

§data: Vec<u8>

Data payload (base64 encoded in JSON).

§seqno: Vec<u8>

Sequence number for ordering.

§topic_ids: Vec<String>

Topic IDs the message was received on.

§topic: String

Primary topic (convenience field).

Implementations§

Source§

impl PubsubMessage

Source

pub fn new( from: String, data: Vec<u8>, seqno: Vec<u8>, topic_ids: Vec<String>, topic: String, ) -> Self

Create a new pubsub message with all fields.

§Arguments
  • from - Peer ID of the sender
  • data - Message payload
  • seqno - Sequence number bytes
  • topic_ids - List of topic IDs
  • topic - Primary topic
Source

pub fn simple(from: String, topic: String, data: Vec<u8>) -> Self

Create a simple message for a single topic.

This is a convenience method that sets seqno to empty and derives topic_ids from the single topic.

Source

pub fn with_seqno( from: String, topic: String, data: Vec<u8>, seqno: Vec<u8>, ) -> Self

Create a message with a sequence number.

Source

pub fn data_string(&self) -> Option<String>

Get the message data as a UTF-8 string (if valid).

Trait Implementations§

Source§

impl Clone for PubsubMessage

Source§

fn clone(&self) -> PubsubMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PubsubMessage

Source§

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

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

impl<'de> Deserialize<'de> for PubsubMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PubsubMessage

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,