pub enum BrowserPoolError {
BrowserCreation(String),
HealthCheckFailed(String),
ShuttingDown,
Configuration(String),
}Expand description
Errors that can occur during browser pool operations.
This enum represents all possible error conditions when working with the browser pool. Each variant includes context about what went wrong.
§Example
use html2pdf_api::BrowserPoolError;
fn handle_error(error: BrowserPoolError) {
match error {
BrowserPoolError::BrowserCreation(msg) => {
eprintln!("Browser creation failed: {}", msg);
}
BrowserPoolError::HealthCheckFailed(msg) => {
eprintln!("Health check failed: {}", msg);
}
BrowserPoolError::ShuttingDown => {
eprintln!("Pool is shutting down");
}
BrowserPoolError::Configuration(msg) => {
eprintln!("Configuration error: {}", msg);
}
}
}Variants§
BrowserCreation(String)
Failed to create a new browser instance.
This typically indicates Chrome/Chromium binary issues or launch flag problems.
§Common Causes
- Chrome/Chromium binary not found or not installed
- Invalid Chrome binary path specified
- Insufficient permissions to execute Chrome
- Invalid or conflicting launch flags
- System resource limits exceeded (e.g., too many processes)
§Example
use html2pdf_api::BrowserPoolError;
let error = BrowserPoolError::BrowserCreation(
"Chrome binary not found".to_string()
);
println!("{}", error); // "Failed to create browser: Chrome binary not found"HealthCheckFailed(String)
Browser failed a health check operation.
Triggered when ping operations (new_tab, navigate, close) fail.
§Common Causes
- Browser process crashed unexpectedly
- Out of memory condition
- CDP (Chrome DevTools Protocol) connection lost
- Browser tab became unresponsive
§Recovery
The pool automatically removes unhealthy browsers and creates replacements. Users typically don’t need to handle this error specially unless monitoring browser health.
§Example
use html2pdf_api::BrowserPoolError;
let error = BrowserPoolError::HealthCheckFailed(
"new_tab() failed: connection refused".to_string()
);
println!("{}", error); // "Browser health check failed: new_tab() failed: connection refused"ShuttingDown
Operation attempted during pool shutdown.
All operations are rejected once shutdown begins.
This error is returned when:
BrowserPool::shutdown()has been calledBrowserPool::shutdown_async()has been called- The
BrowserPoolis being dropped
§Handling
This error typically occurs during application shutdown. Handle it gracefully by stopping any pending work rather than retrying.
§Example
use html2pdf_api::BrowserPoolError;
let error = BrowserPoolError::ShuttingDown;
println!("{}", error); // "Pool is shutting down"Configuration(String)
Invalid configuration provided.
This error occurs when pool configuration values are invalid.
§Common Causes
max_pool_sizeis set to 0warmup_countexceedsmax_pool_size- Invalid Chrome binary path
- Invalid duration values
§Prevention
Use BrowserPoolConfigBuilder
which validates configuration at build time.
§Example
use html2pdf_api::BrowserPoolError;
let error = BrowserPoolError::Configuration(
"max_pool_size must be greater than 0".to_string()
);
println!("{}", error); // "Configuration error: max_pool_size must be greater than 0"Trait Implementations§
Source§impl Debug for BrowserPoolError
impl Debug for BrowserPoolError
Source§impl Display for BrowserPoolError
impl Display for BrowserPoolError
Source§impl Error for BrowserPoolError
impl Error for BrowserPoolError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl From<&str> for BrowserPoolError
Convenience conversion from &str to BrowserPoolError::Configuration.
impl From<&str> for BrowserPoolError
Convenience conversion from &str to BrowserPoolError::Configuration.
Allows using string literals directly where BrowserPoolError is expected.
§Example
use html2pdf_api::BrowserPoolError;
let error: BrowserPoolError = "invalid setting".into();
assert!(matches!(error, BrowserPoolError::Configuration(_)));Source§impl From<String> for BrowserPoolError
Convenience conversion from String to BrowserPoolError::Configuration.
impl From<String> for BrowserPoolError
Convenience conversion from String to BrowserPoolError::Configuration.
Allows using the ? operator with functions that return String errors
in contexts expecting BrowserPoolError.
§Example
use html2pdf_api::BrowserPoolError;
let error: BrowserPoolError = "invalid configuration".to_string().into();
assert!(matches!(error, BrowserPoolError::Configuration(_)));Auto Trait Implementations§
impl Freeze for BrowserPoolError
impl RefUnwindSafe for BrowserPoolError
impl Send for BrowserPoolError
impl Sync for BrowserPoolError
impl Unpin for BrowserPoolError
impl UnwindSafe for BrowserPoolError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);