add BinaryString

rpc/types/README.md

@@ -46,15 +46,17 @@ TODO: fix doc links when types are ready.
 # Mixed types
 Note that some types within [`other`] mix JSON & binary together, i.e.,
 the message overall is JSON, however some fields contain binary
-values, for example:
+values inside JSON strings, for example:
 
 ```json
 {
   "string": "",
   "float": 30.0,
   "integer": 30,
-  "binary": /* serialized binary */
+  "binary": "<serialized binary>"
 }
 ```
 
+`binary` here is (de)serialized as a normal [`String`]. In order to be clear on which fields contain binary data, the struct fields that have them will use [`crate::data::BinaryString`] instead of [`String`].
+
 TODO: list the specific types.

rpc/types/src/data.rs

@@ -1,11 +0,0 @@
-//! Data structures that appear in other types.
-
-//---------------------------------------------------------------------------------------------------- Import
-
-//---------------------------------------------------------------------------------------------------- TODO
-
-//---------------------------------------------------------------------------------------------------- Tests
-#[cfg(test)]
-mod test {
-    // use super::*;
-}

rpc/types/src/data/binary_string.rs

@@ -0,0 +1,29 @@
+//! TODO
+
+//---------------------------------------------------------------------------------------------------- Import
+
+//---------------------------------------------------------------------------------------------------- BinaryString
+/// TODO
+///
+/// ```rust
+/// use serde::Deserialize;
+/// use serde_json::from_str;
+/// use cuprate_rpc_types::data::BinaryString;
+///
+/// #[derive(Deserialize)]
+/// struct Key {
+///     key: BinaryString,
+/// }
+///
+/// let binary = r"<22>\b<><62><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>";
+/// let json = format!("{{\"key\":\"{binary}\"}}");
+/// let key = from_str::<Key>(&json).unwrap();
+/// let binary: BinaryString = key.key;
+/// ```
+pub type BinaryString = String;
+
+//---------------------------------------------------------------------------------------------------- Tests
+#[cfg(test)]
+mod test {
+    // use super::*;
+}

rpc/types/src/data/mod.rs

@@ -0,0 +1,6 @@
+//! Data structures that appear in other types.
+//!
+//! TODO
+
+mod binary_string;
+pub use binary_string::BinaryString;

rpc/types/src/lib.rs

@@ -95,14 +95,12 @@
 )]
 
 //---------------------------------------------------------------------------------------------------- Use
-// Misc types.
+mod macros;
 mod status;
+
 pub use status::Status;
 
-// Internal modules.
-mod macros;
-
-// Request/response JSON/binary/other types.
 pub mod bin;
+pub mod data;
 pub mod json;
 pub mod other;