From 92641d0628e5e40d2ce934286d87780690b960f7 Mon Sep 17 00:00:00 2001
From: strawberry <strawberry@puppygock.gay>
Date: Tue, 16 Jan 2024 20:44:20 -0500
Subject: [PATCH] first of many small code documentation
Signed-off-by: strawberry <strawberry@puppygock.gay>
---
src/api/client_server/media.rs | 6 ++++--
src/api/client_server/mod.rs | 7 +++++++
src/config/mod.rs | 3 +++
3 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/src/api/client_server/media.rs b/src/api/client_server/media.rs
index d114cf671..a00f0abb8 100644
--- a/src/api/client_server/media.rs
+++ b/src/api/client_server/media.rs
@@ -9,9 +9,10 @@
},
};
+/// generated MXC ID (`media-id`) length
const MXC_LENGTH: usize = 32;
-/// # `GET /_matrix/media/r0/config`
+/// # `GET /_matrix/media/v3/config`
///
/// Returns max upload size.
pub async fn get_media_config_route(
@@ -22,7 +23,7 @@ pub async fn get_media_config_route(
})
}
-/// # `POST /_matrix/media/r0/upload`
+/// # `POST /_matrix/media/v3/upload`
///
/// Permanently save media in the server.
///
@@ -58,6 +59,7 @@ pub async fn create_content_route(
})
}
+/// helper method to fetch remote media from other servers over federation
pub async fn get_remote_content(
mxc: &str,
server_name: &ruma::ServerName,
diff --git a/src/api/client_server/mod.rs b/src/api/client_server/mod.rs
index 29a3cb168..84eb641cb 100644
--- a/src/api/client_server/mod.rs
+++ b/src/api/client_server/mod.rs
@@ -68,7 +68,14 @@
pub use user_directory::*;
pub use voip::*;
+/// generated device ID length
pub const DEVICE_ID_LENGTH: usize = 10;
+
+/// generated user access token length
pub const TOKEN_LENGTH: usize = 32;
+
+/// generated user session ID length
pub const SESSION_ID_LENGTH: usize = 32;
+
+/// auto-generated password length
pub const AUTO_GEN_PASSWORD_LENGTH: usize = 25;
diff --git a/src/config/mod.rs b/src/config/mod.rs
index 3b03a7a57..051019976 100644
--- a/src/config/mod.rs
+++ b/src/config/mod.rs
@@ -14,10 +14,13 @@
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>,
--
GitLab