browser-commander 0.18.0

Universal browser automation library that supports multiple browser engines with a unified API
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

// @generated by scripts/generate-playwright-protocol.mjs from
// rust/protocol/playwright/*.yml. Do not edit by hand.

#![allow(clippy::all, missing_docs, unused_imports)]

use serde::{Deserialize, Serialize};

use super::*;
use crate::playwright::connection::{
    Binary, Channel, ChannelType, ObjectRef, ProtocolError, ProtocolEvent, Ref,
};

/// Initializer the driver sends when it creates a `Artifact`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArtifactInitializer {
    #[serde(rename = "absolutePath")]
    pub absolute_path: String,
}

/// Result of `Artifact.pathAfterFinished`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArtifactPathAfterFinishedResult {
    #[serde(rename = "value")]
    pub value: String,
}

/// Parameters of `Artifact.saveAs`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArtifactSaveAsParams {
    #[serde(rename = "path")]
    pub path: String,
}

/// Result of `Artifact.saveAsStream`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArtifactSaveAsStreamResult {
    #[serde(rename = "stream")]
    pub stream: Ref<Stream>,
}

/// Result of `Artifact.failure`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArtifactFailureResult {
    #[serde(rename = "error", default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

/// Result of `Artifact.stream`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct ArtifactStreamResult {
    #[serde(rename = "stream")]
    pub stream: Ref<Stream>,
}

/// Events a `Artifact` channel can emit.
#[derive(Debug, Clone, PartialEq)]
pub enum ArtifactEvent {
    /// An event this binding does not know (a newer driver).
    Unknown {
        /// Event name.
        method: String,
        /// Raw event parameters.
        params: serde_json::Value,
    },
}

impl ProtocolEvent for ArtifactEvent {
    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
        match method {
            _ => Ok(Self::Unknown { method: method.to_string(), params }),
        }
    }
}

/// Channel for the `Artifact` interface (`artifact.yml`).
#[derive(Debug, Clone)]
pub struct Artifact {
    channel: Channel,
}

impl ChannelType for Artifact {
    const INTERFACE: &'static str = "Artifact";
    type Initializer = ArtifactInitializer;
    type Event = ArtifactEvent;

    fn accepts(interface: &str) -> bool {
        matches!(interface, "Artifact")
    }

    fn from_channel(channel: Channel) -> Self {
        Self { channel }
    }

    fn channel(&self) -> &Channel {
        &self.channel
    }
}

impl Artifact {
    /// `Artifact.pathAfterFinished` (internal).
    pub async fn path_after_finished(&self) -> Result<ArtifactPathAfterFinishedResult, ProtocolError> {
        self.channel.send("pathAfterFinished", &serde_json::json!({})).await
    }

    /// `Artifact.saveAs` (internal).
    pub async fn save_as(&self, params: ArtifactSaveAsParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("saveAs", &params).await
    }

    /// `Artifact.saveAsStream` (internal).
    pub async fn save_as_stream(&self) -> Result<ArtifactSaveAsStreamResult, ProtocolError> {
        self.channel.send("saveAsStream", &serde_json::json!({})).await
    }

    /// `Artifact.failure` (internal).
    pub async fn failure(&self) -> Result<ArtifactFailureResult, ProtocolError> {
        self.channel.send("failure", &serde_json::json!({})).await
    }

    /// `Artifact.stream` (internal).
    pub async fn stream(&self) -> Result<ArtifactStreamResult, ProtocolError> {
        self.channel.send("stream", &serde_json::json!({})).await
    }

    /// `Artifact.cancel` (internal).
    pub async fn cancel(&self) -> Result<(), ProtocolError> {
        self.channel.send_no_result("cancel", &serde_json::json!({})).await
    }

    /// `Artifact.delete` (internal).
    pub async fn delete(&self) -> Result<(), ProtocolError> {
        self.channel.send_no_result("delete", &serde_json::json!({})).await
    }
}