tauri-workspace/core/tauri/src/api/mod.rs

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

//! The Tauri API interface.
#![warn(missing_docs)]
// #![feature(const_int_pow)]

/// The App API module allows you to manage application processes.
pub mod app;
/// The Command API module allows you to manage child processes.
pub mod command;
/// The Dialog API module allows you to show messages and prompt for file paths.
pub mod dialog;
/// The Dir module is a helper for file system directory management.
pub mod dir;
/// The File API module contains helpers to perform file operations.
pub mod file;
/// The HTTP request API.
pub mod http;
/// The file system path operations API.
pub mod path;
/// The RPC module includes utilities to send messages to the JS layer of the webview.
pub mod rpc;
/// The shell api.
pub mod shell;
/// TCP ports access API.
pub mod tcp;
/// The semver API.
pub mod version;

/// The Tauri config definition.
pub use tauri_utils::config;

/// The CLI args interface.
#[cfg(feature = "cli")]
pub mod cli;

#[cfg(feature = "cli")]
pub use clap;

/// Global shortcuts interface.
#[cfg(global_shortcut_all)]
pub mod shortcuts;

/// The desktop notifications API module.
#[cfg(notification_all)]
pub mod notification;

pub use tauri_utils::*;

mod error;

/// Tauri API error.
pub use error::Error;
/// Tauri API result type.
pub type Result<T> = std::result::Result<T, Error>;

/// `App` package information.
#[derive(Debug, Clone)]
pub struct PackageInfo {
  /// App name.
  pub name: &'static str,
  /// App version.
  pub version: &'static str,
}

// Not public API
#[doc(hidden)]
pub mod private {
  // Core API only.
  pub mod async_runtime {
    use once_cell::sync::OnceCell;
    use tokio::runtime::Runtime;
    pub use tokio::sync::{
      mpsc::{channel, Receiver, Sender},
      Mutex,
    };

    use std::future::Future;

    static RUNTIME: OnceCell<Runtime> = OnceCell::new();

    pub fn block_on<F: Future>(task: F) -> F::Output {
      let runtime = RUNTIME.get_or_init(|| Runtime::new().unwrap());
      runtime.block_on(task)
    }

    pub fn spawn<F>(task: F)
    where
      F: Future + Send + 'static,
      F::Output: Send + 'static,
    {
      let runtime = RUNTIME.get_or_init(|| Runtime::new().unwrap());
      runtime.spawn(task);
    }
  }
  pub use once_cell::sync::OnceCell;

  pub trait AsTauriContext {
    fn config() -> &'static crate::api::config::Config;
    fn assets() -> &'static crate::api::assets::EmbeddedAssets;
    fn default_window_icon() -> Option<&'static [u8]>;
    fn package_info() -> crate::api::PackageInfo;
  }
}