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::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 browser;
68#[cfg(feature = "_cache")]
69pub mod cache;
70#[cfg(feature = "_cache")]
71pub mod http;
72
73pub(crate) mod cmd;
74pub mod conn;
75pub mod detection;
76pub mod element;
77pub mod error;
78pub mod handler;
79pub mod javascript;
80pub mod js;
81pub mod keys;
82pub mod layout;
83pub mod listeners;
84pub mod page;
85pub mod utils;
86
87use crate::handler::http::HttpRequest;
88use std::sync::Arc;
89
90/// re-export fingerprint management.
91pub use spider_fingerprint;
92/// re-export network blocker.
93pub use spider_network_blocker;
94
95#[cfg(feature = "firewall")]
96/// re-export firewall.
97pub use spider_firewall;
98
99pub use crate::browser::{Browser, BrowserConfig};
100pub use crate::conn::Connection;
101pub use crate::element::Element;
102pub use crate::error::Result;
103#[cfg(feature = "fetcher")]
104pub use crate::fetcher::{BrowserFetcher, BrowserFetcherOptions};
105pub use crate::handler::Handler;
106pub use crate::page::Page;
107/// re-export the generated cdp types
108pub use chromiumoxide_cdp::cdp;
109pub use chromiumoxide_types::{self as types, Binary, Command, Method, MethodType};
110
111#[cfg(feature = "fetcher")]
112pub mod fetcher {
113    pub use chromiumoxide_fetcher::*;
114}
115
116/// HTTP request.
117pub type ArcHttpRequest = Option<Arc<HttpRequest>>;
118
119pub use serde;
120#[cfg(not(feature = "simd"))]
121pub use serde_json;
122#[cfg(feature = "simd")]
123pub use sonic_rs as serde_json;
124
125/// Init the cache global worker.
126#[cfg(feature = "_cache")]
127pub use cache::dump_remote::init_default_cache_worker;
chromiumoxide/lib.rs

chromiumoxide/
lib.rs
