codetether-browser 0.1.0

Browser automation runtime for CodeTether
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Shared browser session state.
//!
//! The public session handle is cloneable while the backend-specific runtime
//! state remains behind internal synchronization.

use std::sync::Arc;
use tokio::sync::Mutex;

/// Cloneable handle for executing browser commands.
///
/// # Examples
///
/// ```rust
/// use codetether_browser::BrowserSession;
///
/// let session = BrowserSession::new();
/// let clone = session.clone();
/// drop(clone);
/// ```
#[derive(Clone, Default)]
pub struct BrowserSession {
    pub(super) inner: Arc<SessionInner>,
}

/// Internal backend state stored by a browser session.
#[derive(Default)]
pub(super) struct SessionInner {
    #[cfg(feature = "tetherscript")]
    pub native: Mutex<Option<super::native::NativeRuntime>>,
}

impl BrowserSession {
    /// Create an empty browser session handle.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use codetether_browser::BrowserSession;
    ///
    /// let session = BrowserSession::new();
    /// let _ = session.clone();
    /// ```
    pub fn new() -> Self {
        Self::default()
    }

    /// Execute a browser command against this session.
    ///
    /// # Errors
    ///
    /// Returns [`crate::browser::BrowserError`] when the backend is not started
    /// or the requested command cannot be completed.
    pub async fn execute(
        &self,
        command: crate::browser::BrowserCommand,
    ) -> Result<crate::browser::BrowserOutput, crate::browser::BrowserError> {
        super::runtime::execute(self, command).await
    }
}