docs(pre-compute,post-compute): improve rustdoc examples

Author: nabil-Tounarti

post-compute/src/api/worker_api.rs

@@ -23,7 +23,7 @@ use serde::Serialize;
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::{
 ///     api::worker_api::ExitMessage,
 ///     compute::errors::ReplicateStatusCause,
@@ -49,7 +49,7 @@ impl<'a> From<&'a ReplicateStatusCause> for ExitMessage<'a> {
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::api::worker_api::WorkerApiClient;
 ///
 /// let client = WorkerApiClient::new("http://worker:13100");
@@ -80,7 +80,7 @@ impl WorkerApiClient {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// use tee_worker_post_compute::api::worker_api::WorkerApiClient;
     ///
     /// let client = WorkerApiClient::from_env();
@@ -119,7 +119,7 @@ impl WorkerApiClient {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// use tee_worker_post_compute::{
     ///     api::worker_api::{ExitMessage, WorkerApiClient},
     ///     compute::errors::ReplicateStatusCause,
@@ -189,7 +189,7 @@ impl WorkerApiClient {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// use tee_worker_post_compute::{
     ///     api::worker_api::WorkerApiClient,
     ///     compute::computed_file::ComputedFile,

post-compute/src/compute/computed_file.rs

@@ -68,7 +68,7 @@ pub struct ComputedFile {
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::compute::computed_file::read_computed_file;
 ///
 /// match read_computed_file("0x123456789abcdef", "/iexec_out") {
@@ -153,7 +153,7 @@ pub fn read_computed_file(
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::compute::computed_file::{
 ///     build_result_digest_in_computed_file,
 ///     ComputedFile
@@ -235,7 +235,7 @@ pub fn build_result_digest_in_computed_file(
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::compute::computed_file::{
 ///     sign_computed_file,
 ///     ComputedFile

post-compute/src/compute/utils/result_utils.rs

@@ -30,7 +30,7 @@ use std::{
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::compute::{computed_file::ComputedFile, utils::result_utils::compute_web3_result_digest};
 ///
 /// let computed_file = ComputedFile {
@@ -93,7 +93,7 @@ pub fn compute_web3_result_digest(computed_file: &ComputedFile) -> String {
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_post_compute::compute::{computed_file::ComputedFile, utils::result_utils::compute_web2_result_digest};
 ///
 /// let computed_file = ComputedFile {
@@ -225,7 +225,7 @@ pub fn sha256_file(file_path: &Path) -> String {
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use std::path::Path;
 /// use tee_worker_post_compute::compute::utils::result_utils::get_file_tree_sha256;
 ///

pre-compute/src/api/worker_api.rs

@@ -22,7 +22,7 @@ use serde::Serialize;
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::api::worker_api::ExitMessage;
 /// use tee_worker_pre_compute::compute::errors::ReplicateStatusCause;
 ///
@@ -46,7 +46,7 @@ impl<'a> From<&'a ReplicateStatusCause> for ExitMessage<'a> {
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::api::worker_api::WorkerApiClient;
 ///
 /// let client = WorkerApiClient::new("http://worker:13100");
@@ -77,7 +77,7 @@ impl WorkerApiClient {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// use tee_worker_pre_compute::api::worker_api::WorkerApiClient;
     ///
     /// let client = WorkerApiClient::from_env();
@@ -116,7 +116,7 @@ impl WorkerApiClient {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// use tee_worker_pre_compute::api::worker_api::{ExitMessage, WorkerApiClient};
     /// use tee_worker_pre_compute::compute::errors::ReplicateStatusCause;
     ///

pre-compute/src/compute/app_runner.rs

@@ -29,7 +29,7 @@ pub enum ExitMode {
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::compute::app_runner::start_with_app;
 /// use tee_worker_pre_compute::compute::pre_compute_app::PreComputeApp;
 ///
@@ -86,7 +86,7 @@ pub fn start_with_app<A: PreComputeAppTrait>(
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::compute::app_runner::start;
 ///
 /// let exit_code = start();

pre-compute/src/compute/pre_compute_app.rs

@@ -49,6 +49,25 @@ impl PreComputeApp {
 }
 
 impl PreComputeAppTrait for PreComputeApp {
+    /// Runs the complete pre-compute pipeline.
+    ///
+    /// This method orchestrates the entire pre-compute process:
+    /// 1. Reads configuration arguments
+    /// 2. Validates the output folder exists
+    /// 3. Downloads and decrypts the dataset (if required)
+    /// 4. Downloads all input files
+    ///
+    /// # Returns
+    ///
+    /// - `Ok(())` if all operations completed successfully
+    /// - `Err(ReplicateStatusCause)` if any step failed
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// let mut app = PreComputeApp::new("task_id".to_string());
+    /// app.run()?;
+    /// ```
     fn run(&mut self) -> Result<(), ReplicateStatusCause> {
         self.pre_compute_args = PreComputeArgs::read_args()?;
         self.check_output_folder()?;
@@ -61,23 +80,6 @@ impl PreComputeAppTrait for PreComputeApp {
         Ok(())
     }
 
-    /// Checks whether the output folder specified in `pre_compute_args` exists.
-    ///
-    /// # Returns
-    ///
-    /// - `Ok(())` if the output directory (`output_dir`) exists.
-    /// - `Err(ReplicateStatusCause::PreComputeOutputFolderNotFound)` if the directory does not exist,
-    ///   or if `pre_compute_args` is missing.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// use tee_worker_pre_compute::compute::pre_compute_app::{PreComputeApp, PreComputeAppTrait};
-    ///
-    /// let mut pre_compute_app = PreComputeApp::new("0x123456789abcdef".to_string());
-    ///
-    /// pre_compute_app.check_output_folder();
-    /// ```
     fn check_output_folder(&self) -> Result<(), ReplicateStatusCause> {
         let output_dir: &str = &self.pre_compute_args.output_dir;
         let chain_task_id: &str = &self.chain_task_id;
@@ -93,31 +95,6 @@ impl PreComputeAppTrait for PreComputeApp {
         Err(ReplicateStatusCause::PreComputeOutputFolderNotFound)
     }
 
-    /// Downloads the input files listed in `pre_compute_args.input_files` to the specified `output_dir`.
-    ///
-    /// Each URL is hashed (SHA-256) to generate a unique local filename.
-    /// If any download fails, the function returns an error.
-    ///
-    /// # Returns
-    ///
-    /// - `Ok(())` if all files are downloaded successfully.
-    /// - `Err(ReplicateStatusCause::PreComputeInputFileDownloadFailed)` if any file fails to download.
-    ///
-    /// # Panics
-    ///
-    /// This function panics if:
-    /// - `pre_compute_args` is `None`.
-    /// - `chain_task_id` is `None`.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// use tee_worker_pre_compute::compute::pre_compute_app::{PreComputeApp, PreComputeAppTrait};
-    ///
-    /// let mut pre_compute_app = PreComputeApp::new("0x123456789abcdef".to_string());
-    ///
-    /// pre_compute_app.download_input_files().unwrap();
-    /// ```
     fn download_input_files(&self) -> Result<(), ReplicateStatusCause> {
         let args = &self.pre_compute_args;
         let chain_task_id: &str = &self.chain_task_id;
@@ -133,23 +110,6 @@ impl PreComputeAppTrait for PreComputeApp {
         Ok(())
     }
 
-    /// Downloads the encrypted dataset file from a URL or IPFS multi-address, and verifies its checksum.
-    ///
-    /// # Returns
-    ///
-    /// * `Ok(Vec<u8>)` containing the dataset's encrypted content if download and verification succeed.
-    /// * `Err(ReplicateStatusCause::PreComputeDatasetDownloadFailed)` if the download fails or inputs are missing.
-    /// * `Err(ReplicateStatusCause::PreComputeInvalidDatasetChecksum)` if checksum validation fails.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// use tee_worker_pre_compute::compute::pre_compute_app::{PreComputeApp, PreComputeAppTrait};
-    ///
-    /// let mut app = PreComputeApp::new("0x123456789abcdef".to_string());
-    ///
-    /// app.download_encrypted_dataset();
-    /// ```
     fn download_encrypted_dataset(&self) -> Result<Vec<u8>, ReplicateStatusCause> {
         let args = &self.pre_compute_args;
         let chain_task_id = &self.chain_task_id;
@@ -192,30 +152,6 @@ impl PreComputeAppTrait for PreComputeApp {
         Ok(encrypted_content)
     }
 
-    /// Decrypts the provided encrypted dataset bytes using AES-CBC.
-    ///
-    /// The first 16 bytes of `encrypted_content` are treated as the IV.
-    /// The rest is the ciphertext. The decryption key is decoded from a Base64 string.
-    ///
-    /// # Arguments
-    ///
-    /// * `encrypted_content` - Full encrypted dataset, including the IV prefix.
-    ///
-    /// # Returns
-    ///
-    /// * `Ok(Vec<u8>)` containing the plaintext dataset if decryption succeeds.
-    /// * `Err(ReplicateStatusCause::PreComputeDatasetDecryptionFailed)` if the key is missing, decoding fails, or decryption fails.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// use tee_worker_pre_compute::compute::pre_compute_app::{PreComputeApp, PreComputeAppTrait};
-    ///
-    /// let mut app = PreComputeApp::new("0x123456789abcdef".to_string());
-    ///
-    /// let encrypted = vec![/* ... */];
-    /// let decrypted = app.decrypt_dataset(&encrypted);
-    /// ```
     fn decrypt_dataset(&self, encrypted_content: &[u8]) -> Result<Vec<u8>, ReplicateStatusCause> {
         let base64_key: &str = &self.pre_compute_args.encrypted_dataset_base64_key;
 
@@ -236,29 +172,6 @@ impl PreComputeAppTrait for PreComputeApp {
             .map_err(|_| ReplicateStatusCause::PreComputeDatasetDecryptionFailed)
     }
 
-    /// Saves the decrypted (plain) dataset to disk in the configured output directory.
-    ///
-    /// The output filename is taken from `pre_compute_args.plain_dataset_filename`.
-    ///
-    /// # Arguments
-    ///
-    /// * `plain_dataset` - The dataset content to write to a file.
-    ///
-    /// # Returns
-    ///
-    /// * `Ok(())` if the file is successfully saved.
-    /// * `Err(ReplicateStatusCause::PreComputeSavingPlainDatasetFailed)` if the path is invalid or write fails.
-    ///
-    /// # Example
-    ///
-    /// ```
-    /// use tee_worker_pre_compute::compute::pre_compute_app::{PreComputeApp, PreComputeAppTrait};
-    ///
-    /// let mut app = PreComputeApp::new("0x123456789abcdef".to_string());
-    ///
-    /// let plain_data = vec![/* ... */];
-    /// app.save_plain_dataset_file(&plain_data);
-    /// ```
     fn save_plain_dataset_file(&self, plain_dataset: &[u8]) -> Result<(), ReplicateStatusCause> {
         let chain_task_id: &str = &self.chain_task_id;
         let args = &self.pre_compute_args;

pre-compute/src/compute/pre_compute_args.rs

@@ -44,7 +44,8 @@ impl PreComputeArgs {
     /// - Missing input file URLs
     ///
     /// # Example
-    /// ```
+    ///
+    /// ```rust
     /// use tee_worker_pre_compute::compute::pre_compute_args::PreComputeArgs;
     ///
     /// // Typically called with task ID from execution context

pre-compute/src/compute/signer.rs

@@ -28,7 +28,7 @@ use alloy_signer_local::PrivateKeySigner;
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::compute::signer::sign_enclave_challenge;
 ///
 /// let message_hash = "0x5cd0e9c5180dd35e2b8285d0db4ded193a9b4be6fbfab90cbadccecab130acad";
@@ -83,7 +83,7 @@ pub fn sign_enclave_challenge(
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::compute::signer::get_challenge;
 ///
 /// // Assuming the necessary environment variables are set:

pre-compute/src/compute/utils/file_utils.rs

@@ -21,7 +21,7 @@ use std::path::{Path, PathBuf};
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use std::path::PathBuf;
 /// use tee_worker_pre_compute::compute::utils::file_utils::write_file;
 ///
@@ -69,7 +69,7 @@ pub fn write_file(content: &[u8], file_path: &Path, context: &str) -> Result<(),
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::compute::utils::file_utils::download_file;
 ///
 /// if let Some(path) = download_file("https://iex.ec/file.txt", "/tmp", "iexec.txt") {
@@ -151,7 +151,7 @@ pub fn download_file(url: &str, parent_dir: &str, filename: &str) -> Option<Path
 ///
 /// # Example
 ///
-/// ```
+/// ```rust
 /// use tee_worker_pre_compute::compute::utils::file_utils::download_from_url;
 /// if let Some(bytes) = download_from_url("https://httpbin.org/json/test.json") {
 ///     println!("Downloaded {} bytes", bytes.len());