From 8d3f9854929f5ffdee3885ff7002f59288d42f7b Mon Sep 17 00:00:00 2001 From: Stefan Hanreich Date: Mon, 25 Nov 2024 18:04:49 +0100 Subject: [PATCH] firewall: alias: document difference between Alias and AliasName Alias and AliasName represent two different parts inside a firewall configuration. Document the respective structs better to make the differences between them clearer. Signed-off-by: Stefan Hanreich --- proxmox-ve-config/src/firewall/types/alias.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/proxmox-ve-config/src/firewall/types/alias.rs b/proxmox-ve-config/src/firewall/types/alias.rs index 553931e..7d56720 100644 --- a/proxmox-ve-config/src/firewall/types/alias.rs +++ b/proxmox-ve-config/src/firewall/types/alias.rs @@ -35,6 +35,8 @@ impl Display for AliasScope { } } +/// Represents the name of an alias in a firewall rule in the RULES section of the firewall +/// configuration. #[derive(Debug, Clone, DeserializeFromStr, SerializeDisplay)] #[cfg_attr(test, derive(Eq, PartialEq))] pub struct AliasName { @@ -86,6 +88,11 @@ impl AliasName { } } +/// Represents an Alias stored in the ALIASES section of the firewall configuration. +/// +/// Since they contain no scope in the firewall configuration itself, this struct also does not +/// contain a scope. The scope has to be inferred from the Context where this Alias is stored, if +/// that is necessary. #[derive(Debug)] #[cfg_attr(test, derive(Eq, PartialEq))] pub struct Alias {