From e4338a9d9d0a76029bca376c2bcb499962575e87 Mon Sep 17 00:00:00 2001
From: Max Audron <audron@cocaine.farm>
Date: Thu, 27 Feb 2025 01:03:29 +0100
Subject: extend docs and reorganize files

---
 src/message/signalproxy/translation/mod.rs | 112 -----------------------------
 1 file changed, 112 deletions(-)
 delete mode 100644 src/message/signalproxy/translation/mod.rs

(limited to 'src/message/signalproxy/translation/mod.rs')

diff --git a/src/message/signalproxy/translation/mod.rs b/src/message/signalproxy/translation/mod.rs
deleted file mode 100644
index a55d6f3..0000000
--- a/src/message/signalproxy/translation/mod.rs
+++ /dev/null
@@ -1,112 +0,0 @@
-/**
-Quassel has 3 main ways to represent an object over the Network:
-
-# VariantList
-The struct is serialized to a Vector of Variants. This is mostly used in the InitData messages.
-First the field name as a ByteArray (UTF-8 String), followed by the field value in it's own Type's variant.
-The order in which the fields are transmitted cannot be assumed.
-
-Example:
-```ignore
-NetworkConfig {
-    ping_timeout_enabled: true,
-    ping_interval: 0,
-}
-```
-to
-```ignore
-VariantList([
-    ByteArray(
-        "pingTimeoutEnabled",
-    ),
-    bool(
-        true,
-    ),
-    ByteArray(
-        "pingInterval",
-    ),
-    i32(
-        30,
-    ),
-])
-```
-
-
-# VariantMap
-The struct is represented as a `VariantMap`. The keys and values of
-the struct are serialized to a corresponding `HashMap<String, Variant>`.
-
-Example:
-```ignore
-NetworkConfig {
-    ping_timeout_enabled: false,
-    ping_interval: 0,
-}
-```
-to
-```ignore
-VariantMap({
-  "pingTimeoutEnabled": bool(false)
-  "pingInterval": i32(0)
-})
-```
-
-## Structure of Arrays
-
-For Objects that are transmitted as multiple at once the VariantMap
-representation is augemented and instead of transmitting multiple `VariantMaps`,
-each field is a `VariantList` of Items.
-
-Example:
-```ignore
-vec![
-    NetworkConfig {
-        ping_timeout_enabled: false,
-        ping_interval: 0,
-    },
-    NetworkConfig {
-        ping_timeout_enabled: true,
-        ping_interval: 1,
-    },
-]
-```
-to
-```ignore
-VariantMap({
-  "pingTimeoutEnabled": VariantList([
-    bool(false),
-    bool(true),
-  ]),
-  "pingInterval": VariantList([
-    i32(0),
-    i32(1),
-  ])
-})
-```
-**/
-use crate::primitive::{Variant, VariantList};
-
-#[deprecated(since="0.1.0", note="please use NetworkMap and NetworkList implementations")]
-pub trait Network {
-    type Item;
-
-    fn to_network(&self) -> Self::Item;
-    fn from_network(input: &mut Self::Item) -> Self;
-}
-
-pub trait NetworkMap
-where
-    // TODO correct this error type
-    Self::Item: TryFrom<Variant, Error = String>,
-    Self::Item: Into<Variant>,
-{
-    type Item;
-
-    fn to_network_map(&self) -> Self::Item;
-    fn from_network_map(input: &mut Self::Item) -> Self;
-}
-
-pub trait NetworkList {
-    fn to_network_list(&self) -> VariantList;
-    fn from_network_list(input: &mut VariantList) -> Self;
-}
-- 
cgit v1.2.3