first of many small code documentation

Signed-off-by: strawberry <strawberry@puppygock.gay>
This commit is contained in:
strawberry 2024-01-16 20:44:20 -05:00 committed by June
parent ad1d272e2a
commit 92641d0628
3 changed files with 14 additions and 2 deletions

View file

@ -14,10 +14,13 @@ mod proxy;
use self::proxy::ProxyConfig;
/// all the config options for conduwuit
#[derive(Clone, Debug, Deserialize)]
pub struct Config {
/// [`IpAddr`] conduwuit will listen on (can be IPv4 or IPv6)
#[serde(default = "default_address")]
pub address: IpAddr,
/// default TCP port conduwuit will listen on
#[serde(default = "default_port")]
pub port: u16,
pub tls: Option<TlsConfig>,