logos-messaging/logos-messaging-rust-bindings
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-rust-bindings.git synced 2026-01-07 08:23:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs links

Browse Source
This commit is contained in:
danielsanchezq 2022-10-31 09:57:21 +01:00
parent 9705c0ef59
commit 6fe2fa8fd1
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
waku/src/decrypt.rs
View File

@ -38,7 +38,7 @@ pub fn waku_decode_symmetric(
/// Decrypt a message using a symmetric key /// Decrypt a message using a symmetric key
/// ///
/// As per the [specification](extern char* waku_decode_asymmetric(char* messageJson, char* privateKey)) /// As per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_decode_asymmetricchar-messagejson-char-privatekey)
pub fn waku_decode_asymmetric( pub fn waku_decode_asymmetric(
message: &WakuMessage, message: &WakuMessage,
asymmetric_key: &SecretKey, asymmetric_key: &SecretKey,

6
waku/src/general/mod.rs
View File

@ -58,9 +58,9 @@ pub(crate) enum JsonResponse<T> {
} }
/// Waku response, just a `Result` with an `String` error. /// Waku response, just a `Result` with an `String` error.
/// Convenient we can transform a [`JsonResponse`] into a [`std::result::Result`]
pub type Result<T> = std::result::Result<T, String>; pub type Result<T> = std::result::Result<T, String>;
/// Convenient we can transform a [`JsonResponse`] into a [`std::result::Result`]
impl<T> From<JsonResponse<T>> for Result<T> { impl<T> From<JsonResponse<T>> for Result<T> {
fn from(response: JsonResponse<T>) -> Self { fn from(response: JsonResponse<T>) -> Self {
match response { match response {
@ -127,14 +127,14 @@ impl WakuMessage {
/// Try decode the message with an expected symmetric key /// Try decode the message with an expected symmetric key
/// ///
/// wrapper around [`crate::decrypt::waku_decode_symmetric`] /// As per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_decode_symmetricchar-messagejson-char-symmetrickey)
pub fn try_decode_symmetric(&self, symmetric_key: &Key<Aes256Gcm>) -> Result<DecodedPayload> { pub fn try_decode_symmetric(&self, symmetric_key: &Key<Aes256Gcm>) -> Result<DecodedPayload> {
waku_decode_symmetric(self, symmetric_key) waku_decode_symmetric(self, symmetric_key)
} }
/// Try decode the message with an expected asymmetric key /// Try decode the message with an expected asymmetric key
/// ///
/// wrapper around [`crate::decrypt::waku_decode_asymmetric`] /// As per the [specification](https://rfc.vac.dev/spec/36/#extern-char-waku_decode_asymmetricchar-messagejson-char-privatekey)
pub fn try_decode_asymmetric(&self, asymmetric_key: &SecretKey) -> Result<DecodedPayload> { pub fn try_decode_asymmetric(&self, asymmetric_key: &SecretKey) -> Result<DecodedPayload> {
waku_decode_asymmetric(self, asymmetric_key) waku_decode_asymmetric(self, asymmetric_key)
} }

2
waku/src/node/peers.rs
View File

@ -158,7 +158,7 @@ impl WakuPeerData {
} }
} }
/// List of [`WakuPeerData`], return value from [`waku_peers`] funtion /// List of [`WakuPeerData`]
pub type WakuPeers = Vec<WakuPeerData>; pub type WakuPeers = Vec<WakuPeerData>;
/// Retrieve the list of peers known by the Waku node /// Retrieve the list of peers known by the Waku node