chromiumoxide/
lib.rs

1#![recursion_limit = "256"]
2//! A high-level API for programmatically interacting with the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
3//!
4//! This crate uses the [Chrome DevTools protocol] to drive/launch a Chromium or
5//! Chrome (potentially headless) browser.
6//!
7//! # Example
8//! ```no_run
9//! use futures_util::StreamExt;
10//! use chromiumoxide::{Browser, BrowserConfig};
11//!
12//! #[tokio::main]
13//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
14//!
15//!     let (browser, mut handler) =
16//!         Browser::launch(BrowserConfig::builder().with_head().build()?).await?;
17//!
18//!     let handle = tokio::task::spawn(async move {
19//!         loop {
20//!             let _event = handler.next().await.unwrap();
21//!         }
22//!     });
23//!
24//!     let page = browser.new_page("https://en.wikipedia.org").await?;
25//!
26//!     // type into the search field and hit `Enter`,
27//!     // this triggers a navigation to the search result page
28//!     page.find_element("input#searchInput")
29//!             .await?
30//!             .click()
31//!             .await?
32//!             .type_str("Rust programming language")
33//!             .await?
34//!             .press_key("Enter")
35//!             .await?;
36//!
37//!     let html = page.wait_for_navigation().await?.content().await?;
38//!
39//!     let _ = handle.await;
40//!     Ok(())
41//! }
42//! ```
43//!
44//! The [`chromiumoxide_pdl`] crate contains a [PDL
45//! parser](chromiumoxide_pdl/src/pdl/parser.rs), which is a rust rewrite of a
46//! [python script in the chromium source tree]( https://chromium.googlesource.com/deps/inspector_protocol/+/refs/heads/master/pdl.py) and a
47//! [`Generator`](chromiumoxide_pdl/src/build/generator.rs) that turns the
48//! parsed PDL files into rust code. The
49//! [`chromiumoxide_cdp`](chromiumoxide_cdp) crate only purpose is to integrate
50//! the generator during is build process and include the generated output
51//! before compiling the crate itself. This separation is done merely because
52//! the generated output is ~60K lines of rust code (not including all the Proc
53//! macro extensions). So expect the compilation to take some time.
54//!
55//! The generator can be configured and used independently, see [`build.rs`] of
56//! [`chromiumoxide_cdp`].
57//!
58//! [chromedp](https://github.com/chromedp/chromedp)
59//! [rust-headless-chrome](https://github.com/Edu4rdSHL/rust-headless-chrome) which the launch
60//! config, `KeyDefinition` and typing support is taken from.
61//! [puppeteer](https://github.com/puppeteer/puppeteer)
62
63#![warn(missing_debug_implementations, rust_2018_idioms)]
64
65pub mod async_process;
66pub mod auth;
67pub mod bg_cleanup;
68pub mod browser;
69#[cfg(feature = "_cache")]
70pub mod cache;
71pub mod content_stream;
72#[cfg(feature = "_cache")]
73pub mod http;
74
75pub mod cmd;
76pub mod conn;
77pub mod detection;
78pub mod dns;
79pub mod element;
80pub mod error;
81pub mod handler;
82pub mod javascript;
83pub mod js;
84pub mod keys;
85pub mod layout;
86pub mod listeners;
87pub mod mouse;
88pub mod page;
89pub mod runtime_release;
90pub mod uring_fs;
91pub mod utils;
92
93use crate::handler::http::HttpRequest;
94use std::sync::Arc;
95
96/// re-export fingerprint management.
97pub use spider_fingerprint;
98/// re-export network blocker.
99pub use spider_network_blocker;
100
101#[cfg(feature = "firewall")]
102/// re-export firewall.
103pub use spider_firewall;
104
105pub use crate::browser::{Browser, BrowserConfig};
106pub use crate::conn::Connection;
107pub use crate::element::Element;
108pub use crate::error::Result;
109#[cfg(feature = "fetcher")]
110pub use crate::fetcher::{BrowserFetcher, BrowserFetcherOptions};
111pub use crate::handler::page::active_page_count;
112pub use crate::handler::Handler;
113pub use crate::page::Page;
114/// re-export the generated cdp types
115pub use chromiumoxide_cdp::cdp;
116pub use chromiumoxide_types::{self as types, Binary, Command, Method, MethodType};
117
118#[cfg(feature = "fetcher")]
119pub mod fetcher {
120    pub use chromiumoxide_fetcher::*;
121}
122
123/// HTTP request.
124pub type ArcHttpRequest = Option<Arc<HttpRequest>>;
125
126pub use serde;
127#[cfg(not(feature = "simd"))]
128pub use serde_json;
129#[cfg(feature = "simd")]
130pub use sonic_rs as serde_json;
131
132/// Init the cache global worker.
133#[cfg(feature = "_cache")]
134pub use cache::dump_remote::init_default_cache_worker;
chromiumoxide/lib.rs

chromiumoxide/
lib.rs
