Method progress_create

src/util.rs:1729–1762

Create a server-initiated work-done progress token and send the `window/workDoneProgress/create` request to the client. Returns `Some(token)` on success, `None` when there is no client or the client rejects the request. The caller should pass the returned token to [`progress_begin`], [`progress_report`], and [`progress_end`].

(&self, token_name: &str)

    /// returned token to [`progress_begin`], [`progress_report`], and
    /// [`progress_end`].
    pub(crate) async fn progress_create(&self, token_name: &str) -> Option<NumberOrString> {
        use tower_lsp::lsp_types::request::WorkDoneProgressCreate;

        // Per the LSP spec, servers must only use
        // window/workDoneProgress/create when the client signals
        // support via the window.workDoneProgress capability.
        if !self
            .supports_work_done_progress
            .load(std::sync::atomic::Ordering::Relaxed)
        {
            return None;
        }

        let client = self.client.as_ref()?;
        let token = NumberOrString::String(token_name.to_string());
        let params = WorkDoneProgressCreateParams {
            token: token.clone(),
        };
        // Use a timeout to avoid deadlocking the service loop.
        // progress_create is a server-to-client request; if the
        // client is busy (e.g. flooding didClose/hover), awaiting
        // indefinitely could block the handler and starve other
        // requests.  Progress reporting is best-effort, so timing
        // out is harmless.
        match tokio::time::timeout(
            std::time::Duration::from_secs(2),
            client.send_request::<WorkDoneProgressCreate>(params),
        )
        .await
        {
            Ok(Ok(())) => Some(token),
            _ => None,
        }
    }

    /// Send a `WorkDoneProgressBegin` notification for the given token.
    ///