diff --git a/src/utils.rs b/src/utils.rs index de49d60..5871549 100644 --- a/src/utils.rs +++ b/src/utils.rs @@ -9,7 +9,7 @@ use serde_json::Value; use crate::error::GolgiError; use crate::messages::{SsbMessageKVT, SsbMessageValue}; -/// Function to parse an array of bytes (returned by an rpc call) into a KVT. +/// Parse an array of bytes (returned by an rpc call) into a `KVT`. /// /// # Arguments /// @@ -20,7 +20,7 @@ pub fn kvt_res_parse(body: &[u8]) -> Result { Ok(kvt) } -/// Function to parse an array of bytes (returned by an rpc call) into a String. +/// Parse an array of bytes (returned by an rpc call) into a `String`. /// /// # Arguments /// @@ -29,7 +29,7 @@ pub fn string_res_parse(body: &[u8]) -> Result { Ok(std::str::from_utf8(body)?.to_string()) } -/// Function to parse an array of bytes (returned by an rpc call) into a serde_json::Value. +/// Parse an array of bytes (returned by an rpc call) into a `serde_json::Value`. /// /// # Arguments /// @@ -39,7 +39,7 @@ pub fn json_res_parse(body: &[u8]) -> Result { Ok(message) } -/// Function to parse an array of bytes (returned by an rpc call) into an SsbMessageValue +/// Parse an array of bytes (returned by an rpc call) into an `SsbMessageValue`. /// /// # Arguments /// @@ -49,17 +49,18 @@ pub fn ssb_message_res_parse(body: &[u8]) -> Result Ok(message) } -/// Takes in an rpc request number, and a handling function, -/// and waits for an rpc response which matches the request number, -/// and then calls the handling function on the response. +/// Take in an RPC request number along with a handling function and wait for +/// an RPC response which matches the request number. Then, call the handling +/// function on the response. /// /// # Arguments /// /// * `rpc_reader` - A `RpcReader` which can return Messages in a loop /// * `req_no` - A `RequestNo` of the response to listen for -/// * `f` - A function which takes in an array of u8 and returns a Result. -/// This is a function which parses the response from the RpcReader. T is a generic type, -/// so this parse function can return multiple possible types (String, json, custom struct etc.) +/// * `f` - A function which takes in an array of `u8` and returns a +/// `Result`. This is a function which parses the response from +/// the `RpcReader`. `T` is a generic type, so this parse function can return +/// multiple possible types (`String`, JSON, custom struct etc.) pub async fn get_async<'a, R, T, F>( rpc_reader: &mut RpcReader, req_no: RequestNo, @@ -91,19 +92,19 @@ where } } -/// Takes in an rpc request number, and a handling function, -/// and calls the handling function on all RPC responses which match the request number, -/// appending the result of each parsed message to a vector, -/// until a CancelStreamResponse is found, marking the end of the stream, -/// and then finally a result is returned. +/// Take in an RPC request number along with a handling function and call +/// the handling function on all RPC responses which match the request number, +/// appending the result of each parsed message to a vector until a +/// `CancelStreamResponse` is found (marking the end of the stream). /// /// # Arguments /// /// * `rpc_reader` - A `RpcReader` which can return Messages in a loop /// * `req_no` - A `RequestNo` of the response to listen for -/// * `f` - A function which takes in an array of u8 and returns a Result. -/// This is a function which parses the response from the RpcReader. T is a generic type, -/// so this parse function can return multiple possible types (String, json, custom struct etc.) +/// * `f` - A function which takes in an array of `u8` and returns a +/// `Result`. This is a function which parses the response from +/// the `RpcReader`. `T` is a generic type, so this parse function can return +/// multiple possible types (`String`, JSON, custom struct etc.) pub async fn get_source_until_eof<'a, R, T, F>( rpc_reader: &mut RpcReader, req_no: RequestNo, @@ -141,19 +142,20 @@ where Ok(messages) } -/// Takes in an rpc request number, and a handling function, -/// and calls the handling function on all responses which match the request number, -/// and prints out the result of the handling function. +/// Take in an RPC request number along with a handling function and call the +/// handling function on all responses which match the request number. Then, +/// prints out the result of the handling function. /// -/// This is a function useful for debugging, and only prints the output. +/// This function useful for debugging and only prints the output. /// /// # Arguments /// /// * `rpc_reader` - A `RpcReader` which can return Messages in a loop /// * `req_no` - A `RequestNo` of the response to listen for -/// * `f` - A function which takes in an array of u8 and returns a Result. -/// This is a function which parses the response from the RpcReader. T is a generic type, -/// so this parse function can return multiple possible types (String, json, custom struct etc.) +/// * `f` - A function which takes in an array of `u8` and returns a +/// `Result`. This is a function which parses the response from +/// the `RpcReader`. `T` is a generic type, so this parse function can return +/// multiple possible types (`String`, JSON, custom struct etc.) pub async fn print_source_until_eof<'a, R, T, F>( rpc_reader: &mut RpcReader, req_no: RequestNo, @@ -183,17 +185,18 @@ where Ok(()) } -/// Takes in an rpc request number, and a handling function (parsing results of type T), -/// and produces an async_std::stream::Stream -/// of results of type T where the handling function is called -/// on all rpc_reader responses which match the request number. +/// Take in an RPC request number along with a handling function (parsing +/// results of type `T`) and produce an `async_std::stream::Stream` of results +/// of type `T`, where the handling function is called on all `RpcReader` +/// responses which match the request number. /// /// # Arguments /// /// * `req_no` - A `RequestNo` of the response to listen for -/// * `f` - A function which takes in an array of u8 and returns a Result. -/// This is a function which parses the response from the RpcReader. T is a generic type, -/// so this parse function can return multiple possible types (String, json, custom struct etc.) +/// * `f` - A function which takes in an array of `u8` and returns a +/// `Result`. This is a function which parses the response from +/// the `RpcReader`. `T` is a generic type, so this parse function can return +/// multiple possible types (`String`, JSON, custom struct etc.) pub async fn get_source_stream<'a, F, T>( mut rpc_reader: RpcReader, req_no: RequestNo,