public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Gabriel Goller <g.goller@proxmox.com>
To: pve-devel@lists.proxmox.com
Cc: Wolfgang Bumiller <w.bumiller@proxmox.com>
Subject: [PATCH proxmox] schema: api_string_type: add from_str method to validate before allocating
Date: Fri, 20 Mar 2026 14:19:07 +0100	[thread overview]
Message-ID: <20260320131920.131477-1-g.goller@proxmox.com> (raw)

The existing from_string takes ownership of a String, meaning callers
with a &str had to heap-allocate first and discard the allocation on
validation failure. The new from_str validates the &str against the
schema's check_constraints before calling to_string(), so no allocation
happens on the error path.

Suggested-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---

Motivation:
This is used quite a lot in proxmox-ve-rs, where we often do e.g.
NetAfi::from_str(afi.to_string()), where from_str is the implementation provided
by the api_string_type macro.

 proxmox-schema/src/api_type_macros.rs | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/proxmox-schema/src/api_type_macros.rs b/proxmox-schema/src/api_type_macros.rs
index f3740d14fd35..dd83f684baba 100644
--- a/proxmox-schema/src/api_type_macros.rs
+++ b/proxmox-schema/src/api_type_macros.rs
@@ -27,6 +27,8 @@
 /// * `fn as_str(&self) -> &str`
 /// * `fn from_string(inner: String) -> Result<Self, anyhow::Error>` using
 ///   `StringSchema::check_constraints`.
+/// * `fn from_str(inner: &str) -> Result<Self, anyhow::Error>` using
+///   `StringSchema::check_constraints`.
 /// * `unsafe fn from_string_unchecked(inner: String) -> Self`
 #[macro_export]
 macro_rules! api_string_type {
@@ -101,6 +103,21 @@ macro_rules! api_string_type {
                 }
                 Ok(Self(inner))
             }
+
+            /// Create an instance from a `&str`, validating it using the API schema's
+            /// [`check_constraints`](::proxmox_schema::StringSchema::check_constraints())
+            /// method.
+            ///
+            /// Validates the string *before* allocating, so no heap allocation occurs on
+            /// failure. Only allocates when the value is guaranteed to be valid.
+            pub fn from_str(inner: &str) -> Result<Self, ::anyhow::Error> {
+                use $crate::ApiType;
+                match &Self::API_SCHEMA {
+                    $crate::Schema::String(s) => s.check_constraints(inner)?,
+                    _ => unreachable!(),
+                }
+                Ok(Self(inner.to_string()))
+            }
         }
 
         impl ::std::fmt::Display for $name {
-- 
2.47.3





                 reply	other threads:[~2026-03-20 13:19 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260320131920.131477-1-g.goller@proxmox.com \
    --to=g.goller@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=w.bumiller@proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal