Docs modules titles and links

This commit is contained in:
Daniel Sanchez Quiros 2022-10-07 12:39:09 +02:00
parent 1b00985e59
commit aa33a7352b
10 changed files with 20 additions and 0 deletions

View File

@ -1,3 +1,5 @@
//! Waku message [event](https://rfc.vac.dev/spec/36/#events) related items
//!
//! Asynchronous events require a callback to be registered.
//! An example of an asynchronous event that might be emitted is receiving a message.
//! When an event is emitted, this callback will be triggered receiving a [`Signal`]

View File

@ -1,3 +1,5 @@
//! Waku [general](https://rfc.vac.dev/spec/36/#general) types
// std
use std::fmt::{Display, Formatter};
use std::str::FromStr;

View File

@ -1,3 +1,5 @@
//! Waku node [configuration](https://rfc.vac.dev/spec/36/#jsonconfig-type) related items
// std
// crates
use libsecp256k1::SecretKey;

View File

@ -1,3 +1,5 @@
//! Waku [filter](https://rfc.vac.dev/spec/36/#waku-filter) protocol related methods
// std
use std::ffi::{CStr, CString};
use std::time::Duration;

View File

@ -1,3 +1,5 @@
//! Waku [lightpush](https://rfc.vac.dev/spec/36/#waku-lightpush) protocol related methods
// std
use std::ffi::{CStr, CString};
use std::time::Duration;

View File

@ -1,3 +1,5 @@
//! Node lifcycle related methods
// std
use multiaddr::Multiaddr;
use std::ffi::{CStr, CString};

View File

@ -1,3 +1,5 @@
//! Waku node implementation
mod config;
mod filter;
mod lightpush;

View File

@ -1,3 +1,5 @@
//! Waku [peer handling and connection](https://rfc.vac.dev/spec/36/#connecting-to-peers) methods
// std
use std::ffi::{CStr, CString};
use std::time::Duration;

View File

@ -1,3 +1,5 @@
//! Waku [relay](https://rfc.vac.dev/spec/36/#waku-relay) protocol related methods
// std
use std::ffi::{CStr, CString};
use std::time::Duration;

View File

@ -1,3 +1,5 @@
//! Waku [store](https://rfc.vac.dev/spec/36/#waku-store) handling methods
// std
use std::ffi::{CStr, CString};
use std::time::Duration;