From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 A4BFA795C5 for ; Tue, 4 May 2021 14:41:46 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 8D04896A7 for ; Tue, 4 May 2021 14:41:16 +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 E7564969E for ; Tue, 4 May 2021 14:41:15 +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 AEA15426AF for ; Tue, 4 May 2021 14:41:15 +0200 (CEST) From: Wolfgang Bumiller To: pbs-devel@lists.proxmox.com Date: Tue, 4 May 2021 14:41:14 +0200 Message-Id: <20210504124114.22036-1-w.bumiller@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.019 Adjusted score from AWL reputation of From: address 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 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [mod.rs] Subject: [pbs-devel] [PATCH proxmox] add api_string_type macro X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 04 May 2021 12:41:46 -0000 Signed-off-by: Wolfgang Bumiller --- Difference to the original RFC for the proxmox-backup crate: * dropped `Debug` implementation * added `TryFrom` implementation proxmox/src/api/api_type_macros.rs | 113 +++++++++++++++++++++++++++++ proxmox/src/api/mod.rs | 3 + 2 files changed, 116 insertions(+) create mode 100644 proxmox/src/api/api_type_macros.rs diff --git a/proxmox/src/api/api_type_macros.rs b/proxmox/src/api/api_type_macros.rs new file mode 100644 index 0000000..542520d --- /dev/null +++ b/proxmox/src/api/api_type_macros.rs @@ -0,0 +1,113 @@ +/// Helper macro to generate a simple string type wrapper. +/// +/// This is meant to be used with an API-type tuple struct containing a single `String` like this: +/// +/// ``` +/// # use proxmox::api::api; +/// # use proxmox::api::schema::ApiStringFormat; +/// # const PROXMOX_SAFE_ID_FORMAT: ApiStringFormat = ApiStringFormat::Enum(&[]); +/// use proxmox::api_string_type; +/// use serde::{Deserialize, Serialize}; +/// +/// api_string_type! { +/// #[api(format: &PROXMOX_SAFE_ID_FORMAT)] +/// /// ACME account name. +/// #[derive(Debug, Clone, Eq, PartialEq, Hash, Deserialize, Serialize)] +/// #[serde(transparent)] +/// pub struct AccountName(String); +/// } +/// ``` +/// +/// This will automatically implements: +/// * `Display` as a pass-through to `String`'s `Display` +/// * `Deref` +/// * `DerefMut` +/// * `AsRef` +/// * `TryFrom` +/// * `fn into_string(self) -> String` +/// * `fn as_str(&self) -> &str` +/// * `fn from_string(inner: String) -> Result` using +/// `StringSchema::check_constraints`. +/// * `unsafe fn from_string_unchecked(inner: String) -> Self` +#[macro_export] +macro_rules! api_string_type { + ( + $(#[$doc:meta])* + $vis:vis struct $name:ident(String); + ) => ( + $(#[$doc])* + $vis struct $name(String); + + impl ::std::ops::Deref for $name { + type Target = str; + + #[inline] + fn deref(&self) -> &str { + &self.0 + } + } + + impl ::std::ops::DerefMut for $name { + #[inline] + fn deref_mut(&mut self) -> &mut str { + &mut self.0 + } + } + + impl AsRef for $name { + #[inline] + fn as_ref(&self) -> &str { + self.0.as_ref() + } + } + + impl ::std::convert::TryFrom for $name { + type Error = ::anyhow::Error; + + fn try_from(inner: String) -> Result { + Self::from_string(inner) + } + } + + impl $name { + /// Get the contained string. + pub fn into_string(self) -> String { + self.0 + } + + /// Get the string as slice. + pub fn as_str(&self) -> &str { + self.0.as_str() + } + + /// Create an instance directly from a `String`. + /// + /// # Safety + /// + /// It is the caller's job to have validated the contents. + /// While there are no memory safety issues, a wrong string can cause API calls to + /// fail parameter validation. + pub unsafe fn from_string_unchecked(name: String) -> Self { + Self(name) + } + + /// Create an instance directly from a `String`, validating it using the API schema's + /// [`check_constraints`](::proxmox::api::schema::StringSchema::check_constraints()) + /// method. + pub fn from_string(inner: String) -> Result { + match &Self::API_SCHEMA { + ::proxmox::api::schema::Schema::String(s) => s.check_constraints(&inner)?, + _ => unreachable!(), + } + Ok(Self(inner)) + } + } + + impl ::std::fmt::Display for $name { + #[inline] + fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { + ::std::fmt::Display::fmt(&self.0, f) + } + } + ); +} diff --git a/proxmox/src/api/mod.rs b/proxmox/src/api/mod.rs index 8c6f597..aaec7df 100644 --- a/proxmox/src/api/mod.rs +++ b/proxmox/src/api/mod.rs @@ -9,6 +9,9 @@ #[cfg(feature = "api-macro")] pub use proxmox_api_macro::{api, router}; +#[macro_use] +mod api_type_macros; + #[doc(hidden)] pub mod const_regex; #[doc(hidden)] -- 2.20.1