Struct HtmlReportOptions 

pub struct HtmlReportOptions<'a> {
    pub benchmark: Option<&'a ReturnSeries>,
    pub rf: f64,
    pub grayscale: bool,
    pub title: String,
    pub output: Option<PathBuf>,
    pub compounded: bool,
    pub periods_per_year: u32,
    pub template_path: Option<PathBuf>,
    pub match_dates: bool,
    pub strategy_title: Option<String>,
    pub benchmark_title: Option<String>,
}

Fields

benchmark: Option<&'a ReturnSeries>

rf: f64

grayscale: bool

title: String

output: Option<PathBuf>

compounded: bool

periods_per_year: u32

template_path: Option<PathBuf>

match_dates: bool

strategy_title: Option<String>

benchmark_title: Option<String>

Implementations

impl<'a> HtmlReportOptions<'a>

pub fn with_benchmark(self, benchmark: &'a ReturnSeries) -> Self

Examples found in repository

examples/html_with_benchmark.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let strategy = common::demo_strategy();
    let benchmark = common::demo_benchmark();

    let options = HtmlReportOptions::default()
        .with_benchmark(&benchmark)
        .with_title("Quantstats-rs Demo Tearsheet (with Benchmark)")
        .with_strategy_title("Strategy")
        .with_benchmark_title("Benchmark Index")
        .with_output("tearsheet_with_benchmark.html");

    let html = html(&strategy, options)?;

    println!(
        "Generated HTML report with benchmark ({} bytes) at tearsheet_with_benchmark.html",
        html.len()
    );

    Ok(())
}

pub fn with_output<P: AsRef<Path>>(self, path: P) -> Self

Examples found in repository

examples/html_report.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let series = common::demo_strategy();

    let options = HtmlReportOptions::default()
        .with_title("Quantstats-rs Demo Tearsheet")
        .with_strategy_title("Demo Strategy")
        .with_output("tearsheet.html");

    let html = html(&series, options)?;

    println!(
        "Generated HTML report ({} bytes) at tearsheet.html",
        html.len()
    );

    Ok(())
}

examples/html_with_benchmark.rs (line 15)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let strategy = common::demo_strategy();
    let benchmark = common::demo_benchmark();

    let options = HtmlReportOptions::default()
        .with_benchmark(&benchmark)
        .with_title("Quantstats-rs Demo Tearsheet (with Benchmark)")
        .with_strategy_title("Strategy")
        .with_benchmark_title("Benchmark Index")
        .with_output("tearsheet_with_benchmark.html");

    let html = html(&strategy, options)?;

    println!(
        "Generated HTML report with benchmark ({} bytes) at tearsheet_with_benchmark.html",
        html.len()
    );

    Ok(())
}

pub fn with_title<S: Into<String>>(self, title: S) -> Self

Examples found in repository

examples/html_report.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let series = common::demo_strategy();

    let options = HtmlReportOptions::default()
        .with_title("Quantstats-rs Demo Tearsheet")
        .with_strategy_title("Demo Strategy")
        .with_output("tearsheet.html");

    let html = html(&series, options)?;

    println!(
        "Generated HTML report ({} bytes) at tearsheet.html",
        html.len()
    );

    Ok(())
}

examples/html_with_benchmark.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let strategy = common::demo_strategy();
    let benchmark = common::demo_benchmark();

    let options = HtmlReportOptions::default()
        .with_benchmark(&benchmark)
        .with_title("Quantstats-rs Demo Tearsheet (with Benchmark)")
        .with_strategy_title("Strategy")
        .with_benchmark_title("Benchmark Index")
        .with_output("tearsheet_with_benchmark.html");

    let html = html(&strategy, options)?;

    println!(
        "Generated HTML report with benchmark ({} bytes) at tearsheet_with_benchmark.html",
        html.len()
    );

    Ok(())
}

pub fn with_strategy_title<S: Into<String>>(self, title: S) -> Self

Examples found in repository

examples/html_report.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let series = common::demo_strategy();

    let options = HtmlReportOptions::default()
        .with_title("Quantstats-rs Demo Tearsheet")
        .with_strategy_title("Demo Strategy")
        .with_output("tearsheet.html");

    let html = html(&series, options)?;

    println!(
        "Generated HTML report ({} bytes) at tearsheet.html",
        html.len()
    );

    Ok(())
}

examples/html_with_benchmark.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let strategy = common::demo_strategy();
    let benchmark = common::demo_benchmark();

    let options = HtmlReportOptions::default()
        .with_benchmark(&benchmark)
        .with_title("Quantstats-rs Demo Tearsheet (with Benchmark)")
        .with_strategy_title("Strategy")
        .with_benchmark_title("Benchmark Index")
        .with_output("tearsheet_with_benchmark.html");

    let html = html(&strategy, options)?;

    println!(
        "Generated HTML report with benchmark ({} bytes) at tearsheet_with_benchmark.html",
        html.len()
    );

    Ok(())
}

pub fn with_benchmark_title<S: Into<String>>(self, title: S) -> Self

Examples found in repository

examples/html_with_benchmark.rs (line 14)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Use shared demo data from examples/common.rs (generated from data file)
    let strategy = common::demo_strategy();
    let benchmark = common::demo_benchmark();

    let options = HtmlReportOptions::default()
        .with_benchmark(&benchmark)
        .with_title("Quantstats-rs Demo Tearsheet (with Benchmark)")
        .with_strategy_title("Strategy")
        .with_benchmark_title("Benchmark Index")
        .with_output("tearsheet_with_benchmark.html");

    let html = html(&strategy, options)?;

    println!(
        "Generated HTML report with benchmark ({} bytes) at tearsheet_with_benchmark.html",
        html.len()
    );

    Ok(())
}

pub fn with_template_path<P: AsRef<Path>>(self, path: P) -> Self

Trait Implementations

impl<'a> Default for HtmlReportOptions<'a>

fn default() -> Self

Returns the “default value” for a type.