Struct Topic

Source
pub struct Topic<R: SecretRotation + Default + Clone + Send + 'static> { /* private fields */ }

Implementations§

Source§

impl<R: SecretRotation + Default + Clone + Send + 'static> Topic<R>

Source

pub async fn new( topic_id: TopicId, endpoint: &Endpoint, node_signing_key: &SigningKey, gossip: Gossip, initial_secret: &Vec<u8>, secret_rotation_function: Option<R>, ) -> Result<Self>

Source

pub fn split(&self) -> (GossipSender, GossipReceiver)

Examples found in repository?
examples/secret_rotation.rs (line 67)
39async fn main() -> Result<()> {
40    // Generate a new random secret key
41    let secret_key = SecretKey::generate(rand::rngs::OsRng);
42
43    // Set up endpoint with discovery enabled
44    let endpoint = Endpoint::builder()
45        .secret_key(secret_key)
46        .discovery_n0()
47        .bind()
48        .await?;
49
50    // Initialize gossip with auto-discovery
51    let gossip = Gossip::builder()
52        .spawn_with_auto_discovery::<MySecretRotation>(endpoint.clone(), None)
53        .await?;
54
55    // Set up protocol router
56    let _router = iroh::protocol::Router::builder(endpoint.clone())
57        .accept(iroh_gossip::ALPN, gossip.gossip.clone())
58        .spawn();
59
60    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
61    let initial_secret = b"my-initial-secret".to_vec();
62
63    // Split into sink (sending) and stream (receiving)
64    let (sink, mut stream) = gossip
65        .subscribe_and_join_with_auto_discovery(topic_id, &initial_secret)
66        .await?
67        .split();
68
69    println!("Joined topic");
70
71    // Spawn listener for incoming messages
72    tokio::spawn(async move {
73        while let Ok(event) = stream.recv().await {
74            if let Event::Received(msg) = event {
75                println!(
76                    "\nMessage from {}: {}",
77                    &msg.delivered_from.to_string()[0..8],
78                    String::from_utf8(msg.content.to_vec()).unwrap()
79                );
80            } else if let Event::NeighborUp(peer) = event {
81                println!("\nJoined by {}", &peer.to_string()[0..8]);
82            }
83        }
84    });
85
86    // Main input loop for sending messages
87    let mut buffer = String::new();
88    let stdin = std::io::stdin();
89    loop {
90        print!("\n> ");
91        stdin.read_line(&mut buffer).unwrap();
92        sink.broadcast(buffer.clone().replace("\n", "").into())
93            .await
94            .unwrap();
95        print!(" - (sent)\n");
96        buffer.clear();
97    }
98}
More examples
Hide additional examples
examples/chat.rs (line 39)
11async fn main() -> Result<()> {
12    // Generate a new random secret key
13    let secret_key = SecretKey::generate(rand::rngs::OsRng);
14
15    // Set up endpoint with discovery enabled
16    let endpoint = Endpoint::builder()
17        .secret_key(secret_key)
18        .discovery_n0()
19        .bind()
20        .await?;
21
22    // Initialize gossip with auto-discovery
23    let gossip = Gossip::builder()
24        .spawn_with_auto_discovery::<DefaultSecretRotation>(endpoint.clone(), None)
25        .await?;
26
27    // Set up protocol router
28    let _router = iroh::protocol::Router::builder(endpoint.clone())
29        .accept(iroh_gossip::ALPN, gossip.gossip.clone())
30        .spawn();
31
32    let topic_id = TopicId::new("my-iroh-gossip-topic".to_string());
33    let initial_secret = b"my-initial-secret".to_vec();
34
35    // Split into sink (sending) and stream (receiving)
36    let (sink, mut stream) = gossip
37        .subscribe_and_join_with_auto_discovery(topic_id, &initial_secret)
38        .await?
39        .split();
40
41    println!("Joined topic");
42
43    // Spawn listener for incoming messages
44    tokio::spawn(async move {
45        while let Ok(event) = stream.recv().await {
46            if let Event::Received(msg) = event {
47                println!(
48                    "\nMessage from {}: {}",
49                    &msg.delivered_from.to_string()[0..8],
50                    String::from_utf8(msg.content.to_vec()).unwrap()
51                );
52            } else if let Event::NeighborUp(peer) = event {
53                println!("\nJoined by {}", &peer.to_string()[0..8]);
54            }
55        }
56    });
57
58    // Main input loop for sending messages
59    let mut buffer = String::new();
60    let stdin = std::io::stdin();
61    loop {
62        print!("\n> ");
63        stdin.read_line(&mut buffer).unwrap();
64        sink.broadcast(buffer.clone().replace("\n", "").into())
65            .await
66            .unwrap();
67        print!(" - (sent)\n");
68        buffer.clear();
69    }
70}
Source

pub fn topic_id(&self) -> &TopicId

Source

pub fn node_id(&self) -> &NodeId

Source

pub fn gossip_sender(&self) -> GossipSender

Source

pub fn gossip_receiver(&self) -> GossipReceiver

Source

pub fn secret_rotation_function(&self) -> R

Source

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

Source

pub fn set_initial_secret_hash(&mut self, initial_secret_hash: [u8; 32])

Source§

impl<R: SecretRotation + Default + Clone + Send + 'static> Topic<R>

Source

pub async fn bootstrap( topic_id: TopicId, endpoint: &Endpoint, node_signing_key: &SigningKey, gossip: Gossip, initial_secret_hash: [u8; 32], secret_rotation_function: Option<R>, ) -> Result<(GossipSender, GossipReceiver)>

Trait Implementations§

Source§

impl<R: Debug + SecretRotation + Default + Clone + Send + 'static> Debug for Topic<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for Topic<R>
where R: Freeze,

§

impl<R> !RefUnwindSafe for Topic<R>

§

impl<R> Send for Topic<R>

§

impl<R> Sync for Topic<R>
where R: Sync,

§

impl<R> Unpin for Topic<R>
where R: Unpin,

§

impl<R> !UnwindSafe for Topic<R>

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

Source§

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = 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> ErasedDestructor for T
where T: 'static,