Fix Rust docs build (#1271)

.github/workflows/mediasoup-rust.yaml

@@ -46,3 +46,10 @@ jobs:
 
       - name: cargo test
         run: cargo test --verbose
+
+      - name: cargo doc
+        run: cargo doc --locked --all --no-deps --lib
+        env:
+          DOCS_RS: '1'
+          RUSTDOCFLAGS: '-D rustdoc::broken-intra-doc-links -D rustdoc::private_intra_doc_links'
+

rust/CHANGELOG.md

@@ -3,6 +3,8 @@
 # NEXT
 
 * Update h264-profile-level-id dependency to 0.2.0.
+* Fix docs build (PR #1271).
+* Rename `data_consumer::on_producer_resume` to `data_consumer::on_data_producer_resume` (PR #1271).
 
 # 0.13.0
 

rust/src/data_structures.rs

@@ -45,7 +45,7 @@ impl AppData {
     }
 }
 
-/// Listening protocol, IP and port for [`WebRtcServer`] to listen on.
+/// Listening protocol, IP and port for [`WebRtcServer`](crate::webrtc_server::WebRtcServer) to listen on.
 ///
 /// # Notes on usage
 /// If you use "0.0.0.0" or "::" as ip value, then you need to also provide `announced_ip`.

rust/src/router/data_consumer.rs

@@ -903,7 +903,10 @@ impl DataConsumer {
     }
 
     /// Callback is called when the associated data producer is resumed.
-    pub fn on_producer_resume<F: Fn() + Send + Sync + 'static>(&self, callback: F) -> HandlerId {
+    pub fn on_data_producer_resume<F: Fn() + Send + Sync + 'static>(
+        &self,
+        callback: F,
+    ) -> HandlerId {
         self.inner()
             .handlers
             .data_producer_resume

worker/build.rs

@@ -2,11 +2,6 @@ use std::process::Command;
 use std::{env, fs};
 
 fn main() {
-    if env::var("DOCS_RS").is_ok() {
-        // Skip everything when building docs on docs.rs
-        return;
-    }
-
     // On Windows Rust always links against release version of MSVC runtime, thus requires
     // Release build here
     let build_type = if cfg!(all(debug_assertions, not(windows))) {
@@ -45,6 +40,11 @@ fn main() {
     )
     .expect("Failed to write generated Rust flatbuffers into fbs.rs");
 
+    if env::var("DOCS_RS").is_ok() {
+        // Skip everything when building docs on docs.rs
+        return;
+    }
+
     // Force forward slashes on Windows too so that is plays well with our tasks.py
     let mediasoup_out_dir = format!("{}/out", out_dir.replace('\\', "/"));