use std::collections::BTreeSet;
use std::fmt;
use std::future::Future;
use std::path::PathBuf;
use std::pin::Pin;
use serde::{Deserialize, Serialize};
use crate::ir::{CodeCell, InputFingerprint};
pub mod assets;
#[cfg(target_os = "linux")]
mod cache;
mod failure;
mod figures;
pub mod identity;
#[cfg(target_os = "linux")]
mod jupyter;
mod options;
pub mod output_safety;
mod records;
pub mod validated;
pub use failure::*;
pub use figures::*;
#[cfg(target_os = "linux")]
pub use jupyter::engine::JupyterEngine;
pub use options::*;
pub use records::*;
pub use validated::{
PageExecutionResult, PreparedExecution, ValidatedPage, ValidatedRepresentationRef,
};
pub type ExecutionFuture<'a> =
Pin<Box<dyn Future<Output = Result<PageExecutionResult, ExecutionFailure>> + Send + 'a>>;
pub type ExecutionCancellation<'a> = Pin<Box<dyn Future<Output = ()> + Send + 'a>>;
pub trait ExecutionEngine: Send + Sync {
fn capabilities(&self) -> ExecutionCapabilities;
fn requirements(&self) -> ExecutionRequirements;
fn execute_page<'a>(
&'a self,
context: ExecutionContext<'a>,
request: &'a PageExecutionRequest,
) -> ExecutionFuture<'a>;
}
pub struct ExecutionContext<'a> {
pub repository_root: PathBuf,
pub page_path: PathBuf,
pub asset_staging_directory: PathBuf,
pub deadlines: ExecutionDeadlines,
pub cancellation: ExecutionCancellation<'a>,
}
impl fmt::Debug for ExecutionContext<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ExecutionContext")
.field("repository_root", &self.repository_root)
.field("page_path", &self.page_path)
.field("asset_staging_directory", &self.asset_staging_directory)
.field("deadlines", &self.deadlines)
.finish_non_exhaustive()
}
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ExecutionCapabilities {
pub languages: BTreeSet<String>,
pub media_types: BTreeSet<String>,
pub features: BTreeSet<ExecutionFeature>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum ExecutionFeature {
PageSession,
Streams,
RichOutput,
DisplayUpdates,
ClearOutput,
AllowedErrors,
Interruption,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ExecutionRequirements {
pub operating_systems: BTreeSet<String>,
pub protocol: KernelProtocolRequirement,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct KernelProtocolRequirement {
pub name: String,
pub major: u32,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PageExecutionRequest {
pub page: ExecutionPage,
pub kernel: String,
pub defaults: ExecutionDefaults,
pub cells: Vec<PreparedCell>,
pub declared_environment_inputs: Vec<InputFingerprint>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PreparedCell {
pub ordinal: usize,
pub cell: CodeCell,
pub options: EffectiveCellOptions,
}