tauri-workspace/core/tauri/src/endpoints/clipboard.rs

// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

#![allow(unused_imports)]

use super::InvokeContext;
#[cfg(any(clipboard_write_text, clipboard_read_text))]
use crate::runtime::ClipboardManager;
use crate::Runtime;
use serde::Deserialize;
use tauri_macros::{command_enum, module_command_handler, CommandModule};

/// The API descriptor.
#[command_enum]
#[derive(Deserialize, CommandModule)]
#[serde(tag = "cmd", content = "data", rename_all = "camelCase")]
pub enum Cmd {
  /// Write a text string to the clipboard.
  #[cmd(clipboard_write_text, "clipboard > writeText")]
  WriteText(String),
  /// Read clipboard content as text.
  ReadText,
}

impl Cmd {
  #[module_command_handler(clipboard_write_text)]
  fn write_text<R: Runtime>(context: InvokeContext<R>, text: String) -> super::Result<()> {
    context
      .window
      .app_handle
      .clipboard_manager()
      .write_text(text)
      .map_err(crate::error::into_anyhow)
  }

  #[module_command_handler(clipboard_read_text)]
  fn read_text<R: Runtime>(context: InvokeContext<R>) -> super::Result<Option<String>> {
    context
      .window
      .app_handle
      .clipboard_manager()
      .read_text()
      .map_err(crate::error::into_anyhow)
  }

  #[cfg(not(clipboard_read_text))]
  fn read_text<R: Runtime>(_: InvokeContext<R>) -> super::Result<()> {
    Err(crate::Error::ApiNotAllowlisted("clipboard > readText".into()).into_anyhow())
  }
}

#[cfg(test)]
mod tests {
  #[tauri_macros::module_command_test(clipboard_write_text, "clipboard > writeText")]
  #[quickcheck_macros::quickcheck]
  fn write_text(text: String) {
    let ctx = crate::test::mock_invoke_context();
    super::Cmd::write_text(ctx.clone(), text.clone()).unwrap();
    #[cfg(clipboard_read_text)]
    assert_eq!(super::Cmd::read_text(ctx).unwrap(), Some(text));
  }

  #[tauri_macros::module_command_test(clipboard_read_text, "clipboard > readText", runtime)]
  #[quickcheck_macros::quickcheck]
  fn read_text() {
    let ctx = crate::test::mock_invoke_context();
    assert_eq!(super::Cmd::read_text(ctx.clone()).unwrap(), None);
    #[cfg(clipboard_write_text)]
    {
      let text = "Tauri!".to_string();
      super::Cmd::write_text(ctx.clone(), text.clone()).unwrap();
      assert_eq!(super::Cmd::read_text(ctx).unwrap(), Some(text));
    }
  }
}