diff --git a/.github/workflows/none.yml b/.github/workflows/none.yml index bce2204..756f464 100644 --- a/.github/workflows/none.yml +++ b/.github/workflows/none.yml @@ -7,6 +7,8 @@ on: - main paths-ignore: - '.github/**' + - 'src/**' + - 'Cargo.toml' jobs: none-shall-pass: diff --git a/Cargo.toml b/Cargo.toml index ff7b54a..ce548fb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,6 @@ -# https://doc.rust-lang.org/cargo/getting-started/first-steps.html#first-steps-with-cargo [package] name = "RuStream" -version = "1.0.0-a" +version = "1.0.0" description = "Self-hosted Streaming Engine, that can render videos via authenticated sessions." license = "MIT" documentation = "https://docs.rs/RuStream" @@ -23,10 +22,6 @@ path = "src/lib.rs" name = "rustream" path = "src/main.rs" -# https://docs.rs/releases/queue -# https://docs.rs/about/metadata -# https://doc.rust-lang.org/cargo/reference/config.html?highlight=RUSTDOCFLAGS -# export RUSTDOCFLAGS="document-private-items no-deps" [package.metadata.docs.rs] rustdoc-args = ["--document-private-items"] diff --git a/src/routes/video.rs b/src/routes/video.rs index 53e521c..9e880db 100644 --- a/src/routes/video.rs +++ b/src/routes/video.rs @@ -32,7 +32,7 @@ struct Subtitles { /// /// * `path` - The input path string to be URL encoded. /// -/// # References: +/// ## References /// - [RustJobs](https://rustjobs.dev/blog/how-to-url-encode-strings-in-rust/) /// /// # Returns diff --git a/src/squire/secure.rs b/src/squire/secure.rs index 28f119f..ea28dac 100644 --- a/src/squire/secure.rs +++ b/src/squire/secure.rs @@ -15,7 +15,7 @@ use sha2::{Digest, Sha512}; /// /// A hexadecimal string representing the SHA-512 hash value. /// -/// ## References: +/// ## References /// - [Official docs](https://docs.rs/sha2/latest/sha2/#usage) pub fn calculate_hash(value: String) -> String { let mut hasher = Sha512::new(); @@ -37,7 +37,7 @@ pub fn calculate_hash(value: String) -> String { /// /// A Base64-encoded ASCII string. /// -/// ## References: +/// ## References /// - [Official docs](https://docs.rs/base64/latest/base64/#url-safe-alphabet) #[allow(dead_code)] // Just for reference pub fn base64_encode(value: &str) -> String { @@ -56,7 +56,7 @@ pub fn base64_encode(value: &str) -> String { /// /// A `Result` containing the decoded string or an error message. /// -/// ## References: +/// ## References /// - [Official Docs](https://docs.rs/base64/latest/base64/#url-safe-alphabet) pub fn base64_decode(value: &str) -> Result { if let Ok(decoded_bytes) = URL_SAFE.decode(value) { diff --git a/src/templates/mod.rs b/src/templates/mod.rs index c5465ac..34e2883 100644 --- a/src/templates/mod.rs +++ b/src/templates/mod.rs @@ -1,17 +1,17 @@ use std::sync::{Arc, Mutex}; /// Index page template that is served as HTML response for the root endpoint. -pub mod index; +mod index; /// Landing page template that is served as HTML response while streaming videos. -pub mod landing; +mod landing; /// Listing page template that is served as HTML response after successful authentication. -pub mod listing; +mod listing; /// Logout page template that is served as HTML response when the user decides to end the session. -pub mod logout; +mod logout; /// Session page template that is served as HTML response when invalid/expired session tokens are received. -pub mod session; +mod session; /// Unauthorized page template that is served as HTML response after failed authentication. -pub mod unauthorized; +mod unauthorized; /// Loads all the HTML templates' content into a Jinja Environment pub fn environment() -> Arc>> {