From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH v2 proxmox-backup 2/5] api types: introduce `BackupArchiveName` type
Date: Wed, 10 Jul 2024 09:48:53 +0200 [thread overview]
Message-ID: <20240710074856.27706-3-c.ebner@proxmox.com> (raw)
In-Reply-To: <20240710074856.27706-1-c.ebner@proxmox.com>
Introduces a dedicated wrapper type to be used for backup archive
names instead of String.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
changes since version 1:
- add missing check for invalid archive names ending in '/'
- import traits at top
- inlined variable names in format strings
pbs-api-types/src/datastore.rs | 107 ++++++++++++++++++++++++++++++++-
1 file changed, 106 insertions(+), 1 deletion(-)
diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
index dfa6bb259..e9e51419a 100644
--- a/pbs-api-types/src/datastore.rs
+++ b/pbs-api-types/src/datastore.rs
@@ -1,5 +1,7 @@
use std::fmt;
use std::path::{Path, PathBuf};
+use std::str::FromStr;
+use std::convert::{AsRef, TryFrom};
use anyhow::{bail, format_err, Error};
use const_format::concatcp;
@@ -1570,7 +1572,7 @@ pub fn print_store_and_ns(store: &str, ns: &BackupNamespace) -> String {
}
}
-#[derive(PartialEq, Eq)]
+#[derive(Clone, PartialEq, Eq)]
/// Allowed variants of backup archives to be contained in a snapshot's manifest
pub enum ArchiveType {
FixedIndex,
@@ -1590,3 +1592,106 @@ impl ArchiveType {
Ok(archive_type)
}
}
+
+#[derive(Clone, PartialEq, Eq)]
+/// Name of archive files contained in snapshot's manifest
+pub struct BackupArchiveName {
+ // archive name including the `.fidx`, `.didx` or `.blob` extension
+ name: String,
+ // type parsed based on given extension
+ ty: ArchiveType,
+}
+
+impl fmt::Display for BackupArchiveName {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{name}", name = self.name)
+ }
+}
+
+serde_plain::derive_deserialize_from_fromstr!(BackupArchiveName, "archive name");
+
+impl FromStr for BackupArchiveName {
+ type Err = Error;
+
+ fn from_str(name: &str) -> Result<Self, Self::Err> {
+ Self::try_from(name)
+ }
+}
+
+serde_plain::derive_serialize_from_display!(BackupArchiveName);
+
+impl TryFrom<&str> for BackupArchiveName {
+ type Error = anyhow::Error;
+
+ fn try_from(value: &str) -> Result<Self, Self::Error> {
+ let (name, ty) = Self::parse_archive_type(value)?;
+ Ok(Self { name, ty })
+ }
+}
+
+impl AsRef<str> for BackupArchiveName {
+ fn as_ref(&self) -> &str {
+ &self.name
+ }
+}
+
+impl BackupArchiveName {
+ pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error> {
+ let path = path.as_ref();
+ if path.as_os_str().as_encoded_bytes().last() == Some(&b'/') {
+ bail!("invalid archive name, got directory");
+ }
+ let file_name = path
+ .file_name()
+ .ok_or_else(|| format_err!("invalid archive name"))?;
+ let name = file_name
+ .to_str()
+ .ok_or_else(|| format_err!("archive name not valid UTF-8"))?;
+
+ Self::try_from(name)
+ }
+
+ pub fn archive_type(&self) -> ArchiveType {
+ self.ty.clone()
+ }
+
+ pub fn ends_with(&self, postfix: &str) -> bool {
+ self.name.ends_with(postfix)
+ }
+
+ pub fn has_pxar_filename_extension(&self) -> bool {
+ self.name.ends_with(".pxar.didx")
+ || self.name.ends_with(".mpxar.didx")
+ || self.name.ends_with(".ppxar.didx")
+ }
+
+ pub fn without_type_extension(&self) -> String {
+ match self.ty {
+ ArchiveType::DynamicIndex => self.name.strip_suffix(".didx").unwrap().into(),
+ ArchiveType::FixedIndex => self.name.strip_suffix(".fidx").unwrap().into(),
+ ArchiveType::Blob => self.name.strip_suffix(".blob").unwrap().into(),
+ }
+ }
+
+ fn parse_archive_type(archive_name: &str) -> Result<(String, ArchiveType), Error> {
+ if archive_name.ends_with(".didx")
+ || archive_name.ends_with(".fidx")
+ || archive_name.ends_with(".blob")
+ {
+ Ok((archive_name.into(), ArchiveType::from_path(archive_name)?))
+ } else if archive_name.ends_with(".pxar")
+ || archive_name.ends_with(".mpxar")
+ || archive_name.ends_with(".ppxar")
+ {
+ Ok((format!("{archive_name}.didx"), ArchiveType::DynamicIndex))
+ } else if archive_name.ends_with(".img") {
+ Ok((format!("{archive_name}.fidx"), ArchiveType::FixedIndex))
+ } else {
+ Ok((format!("{archive_name}.blob"), ArchiveType::Blob))
+ }
+ }
+}
+
+impl ApiType for BackupArchiveName {
+ const API_SCHEMA: Schema = BACKUP_ARCHIVE_NAME_SCHEMA;
+}
--
2.39.2
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2024-07-10 7:49 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-10 7:48 [pbs-devel] [PATCH v2 proxmox-backup 0/5] introduce dedcated archive name api type Christian Ebner
2024-07-10 7:48 ` [pbs-devel] [PATCH v2 proxmox-backup 1/5] datastore: move `ArchiveType` to PBS api types crate Christian Ebner
2024-07-10 7:48 ` Christian Ebner [this message]
2024-07-10 7:48 ` [pbs-devel] [PATCH v2 proxmox-backup 3/5] client/server: use dedicated api type for all archive names Christian Ebner
2024-07-10 7:48 ` [pbs-devel] [PATCH v2 proxmox-backup 4/5] client: drop unused parse_archive_type helper Christian Ebner
2024-07-10 7:48 ` [pbs-devel] [PATCH v2 proxmox-backup 5/5] api types: add unit tests for backup archive name parsing Christian Ebner
2024-07-10 9:17 ` [pbs-devel] [PATCH v2 proxmox-backup 0/5] introduce dedcated archive name api type Gabriel Goller
2024-10-24 8:03 ` Christian Ebner
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=20240710074856.27706-3-c.ebner@proxmox.com \
--to=c.ebner@proxmox.com \
--cc=pbs-devel@lists.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal