From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.csapak@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id 6383DBE51
for <pbs-devel@lists.proxmox.com>; Fri, 8 Apr 2022 11:56:10 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 4FB00D252
for <pbs-devel@lists.proxmox.com>; Fri, 8 Apr 2022 11:56:10 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[94.136.29.106])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS id E9365D20F
for <pbs-devel@lists.proxmox.com>; Fri, 8 Apr 2022 11:56:07 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id C2BD0463F1
for <pbs-devel@lists.proxmox.com>; Fri, 8 Apr 2022 11:56:07 +0200 (CEST)
From: Dominik Csapak <d.csapak@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Fri, 8 Apr 2022 11:56:01 +0200
Message-Id: <20220408095606.2767234-3-d.csapak@proxmox.com>
X-Mailer: git-send-email 2.30.2
In-Reply-To: <20220408095606.2767234-1-d.csapak@proxmox.com>
References: <20220408095606.2767234-1-d.csapak@proxmox.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.140 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
T_SCC_BODY_TEXT_LINE -0.01 -
Subject: [pbs-devel] [PATCH proxmox 2/4] promxox-router: add
SerializableReturn Trait
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Fri, 08 Apr 2022 09:56:10 -0000
this will be useful as a generic return type for api calls which
must implement Serialize.
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
proxmox-router/Cargo.toml | 2 +
proxmox-router/src/lib.rs | 2 +
proxmox-router/src/serializable_return.rs | 62 +++++++++++++++++++++++
3 files changed, 66 insertions(+)
create mode 100644 proxmox-router/src/serializable_return.rs
diff --git a/proxmox-router/Cargo.toml b/proxmox-router/Cargo.toml
index d9f47ea..f042f31 100644
--- a/proxmox-router/Cargo.toml
+++ b/proxmox-router/Cargo.toml
@@ -15,6 +15,7 @@ hyper = { version = "0.14", features = [ "full" ] }
nix = "0.19.1"
percent-encoding = "2.1"
serde_json = "1.0"
+serde = "1.0"
unicode-width ="0.1.8"
# cli:
@@ -24,6 +25,7 @@ libc = { version = "0.2", optional = true }
proxmox-lang = { path = "../proxmox-lang", version = "1.1" }
proxmox-schema = { path = "../proxmox-schema", version = "1.1" }
+proxmox-async = { path = "../proxmox-async", version = "0.4" }
[features]
default = [ "cli" ]
diff --git a/proxmox-router/src/lib.rs b/proxmox-router/src/lib.rs
index dadb917..84f39f8 100644
--- a/proxmox-router/src/lib.rs
+++ b/proxmox-router/src/lib.rs
@@ -12,6 +12,7 @@ pub mod error;
mod permission;
mod router;
mod rpc_environment;
+mod serializable_return;
#[doc(inline)]
pub use error::HttpError;
@@ -19,6 +20,7 @@ pub use error::HttpError;
pub use permission::*;
pub use router::*;
pub use rpc_environment::{RpcEnvironment, RpcEnvironmentType};
+pub use serializable_return::SerializableReturn;
// make list_subdirs_api_method! work without an explicit proxmox-schema dependency:
#[doc(hidden)]
diff --git a/proxmox-router/src/serializable_return.rs b/proxmox-router/src/serializable_return.rs
new file mode 100644
index 0000000..51f6c3c
--- /dev/null
+++ b/proxmox-router/src/serializable_return.rs
@@ -0,0 +1,62 @@
+use serde::Serializer;
+use serde_json::Value;
+
+/// This defines a *fixed* serializer (iow. also where/how to write out the data).
+///
+/// (Note that `serde::Serializer` is implemented for `__&mut__ serde_json::Serializer`.
+type SenderSerializer<'a> = &'a mut serde_json::Serializer<
+ &'a mut std::io::BufWriter<proxmox_async::blocking::SenderWriter>,
+>;
+
+/// This is an object-safe trait which requires the ability to serialize into particular
+/// Serializer instances.
+pub trait SerializableReturn {
+ /// Serializes self into a [`proxmox_async::blocking::SenderWriter`] wrapped
+ /// into a [`std::io::BufWriter`]
+ ///
+ /// If `value` is an Object/Map, serializes that first and puts the value of
+ /// `self` into the `data` property.
+ fn sender_serialize(
+ &self,
+ serializer: SenderSerializer,
+ value: Value,
+ ) -> Result<
+ <SenderSerializer as serde::Serializer>::Ok,
+ <SenderSerializer as serde::Serializer>::Error,
+ >;
+
+ /// Returns a value again from self
+ fn to_value(&self) -> Result<Value, serde_json::error::Error>;
+}
+
+impl<T> SerializableReturn for T
+where
+ T: serde::Serialize,
+{
+ fn sender_serialize(
+ &self,
+ serializer: SenderSerializer,
+ value: Value,
+ ) -> Result<
+ <SenderSerializer as serde::Serializer>::Ok,
+ <SenderSerializer as serde::Serializer>::Error,
+ > {
+ use serde::ser::SerializeMap;
+ if let Some(original) = value.as_object() {
+ let mut map = serializer.serialize_map(None)?;
+ for (k, v) in original {
+ map.serialize_entry(k, v)?;
+ }
+
+ map.serialize_key("data")?;
+ map.serialize_value(&self)?;
+ map.end()
+ } else {
+ self.serialize(serializer)
+ }
+ }
+
+ fn to_value(&self) -> Result<Value, serde_json::error::Error> {
+ serde_json::to_value(self)
+ }
+}
--
2.30.2