proxmox-mirrors/proxmox-ve-rs
1
0
Fork 0
mirror of https://git.proxmox.com/git/proxmox-ve-rs synced 2025-10-04 07:56:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

firewall: alias: document difference between Alias and AliasName

Browse Source 
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 <s.hanreich@proxmox.com>
This commit is contained in:
Stefan Hanreich 2024-11-25 18:04:49 +01:00 committed by Thomas Lamprecht
parent 5e52054af4
commit 8d3f985492
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
proxmox-ve-config/src/firewall/types/alias.rs
View File

@ -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)] #[derive(Debug, Clone, DeserializeFromStr, SerializeDisplay)]
#[cfg_attr(test, derive(Eq, PartialEq))] #[cfg_attr(test, derive(Eq, PartialEq))]
pub struct AliasName { 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)] #[derive(Debug)]
#[cfg_attr(test, derive(Eq, PartialEq))] #[cfg_attr(test, derive(Eq, PartialEq))]
pub struct Alias { pub struct Alias {