document_session_api/
page_capture.rs1use serde::{Deserialize, Serialize};
14
15#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
20pub struct PageCaptureRequestId(u64);
21
22impl PageCaptureRequestId {
23 pub const fn new(value: u64) -> Self {
24 Self(value)
25 }
26
27 pub const fn get(self) -> u64 {
28 self.0
29 }
30}
31
32#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
34pub enum PageCaptureScope {
35 Viewport,
37}
38
39#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
41pub struct PageCaptureRequest {
42 pub id: PageCaptureRequestId,
43 pub scope: PageCaptureScope,
44}
45
46impl PageCaptureRequest {
47 pub const fn viewport(id: PageCaptureRequestId) -> Self {
48 Self {
49 id,
50 scope: PageCaptureScope::Viewport,
51 }
52 }
53}
54
55#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
57pub struct CssPoint {
58 pub x: f32,
59 pub y: f32,
60}
61
62#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
64pub struct CssExtent {
65 pub width: f32,
66 pub height: f32,
67}
68
69#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
75pub struct PageCaptureViewportFacts {
76 pub css_scroll_origin: Option<CssPoint>,
77 pub css_viewport_extent: Option<CssExtent>,
78 pub output_width_pixels: u32,
79 pub output_height_pixels: u32,
80}
81
82impl PageCaptureViewportFacts {
83 pub const fn unknown_css(output_width_pixels: u32, output_height_pixels: u32) -> Self {
86 Self {
87 css_scroll_origin: None,
88 css_viewport_extent: None,
89 output_width_pixels,
90 output_height_pixels,
91 }
92 }
93}
94
95#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
97pub enum PageCaptureImageArtifact {
98 Png(Vec<u8>),
99}
100
101#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
103pub struct PageCaptureOutput {
104 pub scope: PageCaptureScope,
107 pub image: PageCaptureImageArtifact,
108 pub viewport: PageCaptureViewportFacts,
109 pub applied_page_scale: Option<f32>,
112}
113
114#[cfg(test)]
115mod tests {
116 use super::*;
117
118 #[test]
119 fn viewport_facts_keep_unobserved_css_explicit() {
120 let facts = PageCaptureViewportFacts::unknown_css(1280, 720);
121 assert_eq!(facts.css_scroll_origin, None);
122 assert_eq!(facts.css_viewport_extent, None);
123 assert_eq!(facts.output_width_pixels, 1280);
124 assert_eq!(facts.output_height_pixels, 720);
125 }
126
127 #[test]
128 fn viewport_request_keeps_the_host_minted_id() {
129 let id = PageCaptureRequestId::new(42);
130 let request = PageCaptureRequest::viewport(id);
131 assert_eq!(request.id, id);
132 assert_eq!(request.scope, PageCaptureScope::Viewport);
133 }
134}