Struct Config 

pub struct Config {
    pub width: u32,
    pub height: u32,
    pub scale: f32,
    pub format: OutputFormat,
    pub color_scheme: ColorScheme,
    pub auto_height: bool,
    pub background: [u8; 4],
}

Configuration for HTML rendering.

Use the builder pattern to construct a configuration:

use hyper_render::{Config, OutputFormat, ColorScheme};

let config = Config::new()
    .width(1200)
    .height(800)
    .scale(2.0)
    .format(OutputFormat::Pdf)
    .color_scheme(ColorScheme::Dark);

Fields

width: u32

Width of the viewport in pixels.

height: u32

Height of the viewport in pixels.

For PDF output, this may be adjusted based on content length if auto_height is enabled.

scale: f32

Scale factor for rendering (e.g., 2.0 for retina displays).

format: OutputFormat

Output format (PNG or PDF).

color_scheme: ColorScheme

Color scheme preference (light or dark mode).

auto_height: bool

Whether to automatically adjust height based on content.

When enabled, the renderer will compute the actual content height and use that instead of the configured height.

background: [u8; 4]

Background color as RGBA (default: white).

Implementations

impl Config

pub const MIN_DIMENSION: u32 = 16

Minimum supported width/height in pixels.

Very small dimensions can cause overflow issues in the underlying rendering engine.

pub fn new() -> Self

Create a new configuration with default values.

Defaults:

• Width: 800px
• Height: 600px
• Scale: 1.0
• Format: PNG
• Color scheme: Light

pub fn width(self, width: u32) -> Self

Set the viewport width in pixels.

Example

use hyper_render::Config;

let config = Config::new().width(1920);
assert_eq!(config.width, 1920);

pub fn height(self, height: u32) -> Self

Set the viewport height in pixels.

Example

use hyper_render::Config;

let config = Config::new().height(1080);
assert_eq!(config.height, 1080);

pub fn size(self, width: u32, height: u32) -> Self

Set both width and height at once.

Example

use hyper_render::Config;

let config = Config::new().size(1920, 1080);
assert_eq!(config.width, 1920);
assert_eq!(config.height, 1080);

pub fn scale(self, scale: f32) -> Self

Set the scale factor for rendering.

Use 2.0 for retina/HiDPI displays to get crisp output.

Example

use hyper_render::Config;

let config = Config::new().scale(2.0);
assert_eq!(config.scale, 2.0);

pub fn format(self, format: OutputFormat) -> Self

Set the output format.

Example

use hyper_render::{Config, OutputFormat};

let config = Config::new().format(OutputFormat::Pdf);

pub fn color_scheme(self, scheme: ColorScheme) -> Self

Set the color scheme preference.

This affects CSS media queries like prefers-color-scheme.

Example

use hyper_render::{Config, ColorScheme};

let config = Config::new().color_scheme(ColorScheme::Dark);

pub fn auto_height(self, auto: bool) -> Self

Enable automatic height detection.

When enabled, the renderer will compute the actual content height and use that instead of the configured height. This is useful for rendering full-page content.

Example

use hyper_render::Config;

let config = Config::new().auto_height(true);

pub fn background(self, rgba: [u8; 4]) -> Self

Set the background color as RGBA values.

Example

use hyper_render::Config;

// Transparent background
let config = Config::new().background([0, 0, 0, 0]);

// Light gray background
let config = Config::new().background([240, 240, 240, 255]);

pub fn transparent(self) -> Self

Set a transparent background.

Shorthand for .background([0, 0, 0, 0]).

pub fn validate(&self) -> Result<()>

Validate the configuration.

Returns an error if any configuration values are invalid:

• Width must be at least 16
• Height must be at least 16
• Scale must be greater than 0

This is called automatically by the render functions.

Example

use hyper_render::Config;

let config = Config::new().width(0);
assert!(config.validate().is_err());

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.