From fc26194ca2203573e2ef6f2946f1c216b6e96a17 Mon Sep 17 00:00:00 2001 From: 魏曹先生 <1992414357@qq.com> Date: Sun, 21 Sep 2025 16:17:05 +0800 Subject: Add some comment --- crates/env/src/local/config.rs | 18 +++++++++++++++--- crates/env/src/member.rs | 5 +++++ crates/env/src/vault/config.rs | 7 ++++++- 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/crates/env/src/local/config.rs b/crates/env/src/local/config.rs index dcaf4df..ddb7dd0 100644 --- a/crates/env/src/local/config.rs +++ b/crates/env/src/local/config.rs @@ -8,13 +8,15 @@ use crate::constants::PORT; #[derive(Serialize, Deserialize, ConfigFile)] #[cfg_file(path = CLIENT_FILE_WORKSPACE)] pub struct LocalConfig { - target: SocketAddr, + /// The vault address, representing the upstream address of the local workspace, + /// to facilitate timely retrieval of new updates from the upstream source. + vault_addr: SocketAddr, } impl Default for LocalConfig { fn default() -> Self { Self { - target: SocketAddr::V4(std::net::SocketAddrV4::new( + vault_addr: SocketAddr::V4(std::net::SocketAddrV4::new( std::net::Ipv4Addr::new(127, 0, 0, 1), PORT, )), @@ -22,4 +24,14 @@ impl Default for LocalConfig { } } -impl LocalConfig {} +impl LocalConfig { + /// Set the vault address. + pub fn set_vault_addr(&mut self, addr: SocketAddr) { + self.vault_addr = addr; + } + + /// Get the vault address. + pub fn vault_addr(&self) -> SocketAddr { + self.vault_addr + } +} diff --git a/crates/env/src/member.rs b/crates/env/src/member.rs index 34abe0d..0a25151 100644 --- a/crates/env/src/member.rs +++ b/crates/env/src/member.rs @@ -1,3 +1,5 @@ +pub mod manager; + use cfg_file::ConfigFile; use serde::{Deserialize, Serialize}; use string_proc::camel_case; @@ -5,7 +7,10 @@ use uuid::Uuid; #[derive(Debug, Eq, Clone, ConfigFile, Serialize, Deserialize)] pub struct Member { + /// Member ID, used to intuitively display the name to other members id: String, + + /// Member Uuid, used to ensure the uniqueness of this member uuid: Uuid, } diff --git a/crates/env/src/vault/config.rs b/crates/env/src/vault/config.rs index dc815c2..f4e97e6 100644 --- a/crates/env/src/vault/config.rs +++ b/crates/env/src/vault/config.rs @@ -5,11 +5,16 @@ use uuid::Uuid; use crate::constants::SERVER_FILE_VAULT; use crate::member::Member; +pub type MemberUuid = Uuid; + #[derive(Default, Serialize, Deserialize, ConfigFile)] #[cfg_file(path = SERVER_FILE_VAULT)] pub struct VaultConfig { + /// Vault name, which can be used as the project name and generally serves as a hint vault_name: String, - vault_admin_list: Vec, + + /// Vault admin Uuids, a list of member Uuids representing administrator identities + vault_admin_list: Vec, } impl VaultConfig { -- cgit