ruviz 0.4.2

High-performance 2D plotting library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Common utilities for ruviz examples.
//!
//! The repo keeps transient example artifacts under `generated/examples/` and
//! committed release-facing media under `docs/assets/`.

use std::path::PathBuf;

fn ensure_dir(path: PathBuf, label: &str) -> PathBuf {
    if !path.exists() {
        std::fs::create_dir_all(&path).unwrap_or_else(|err| {
            panic!(
                "Failed to create {label} directory {}: {err}",
                path.display()
            )
        });
    }

    path
}

fn project_root() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
}

#[allow(dead_code)]
pub fn generated_root() -> PathBuf {
    ensure_dir(project_root().join("generated"), "generated root")
}

#[allow(dead_code)]
pub fn docs_assets_root() -> PathBuf {
    ensure_dir(
        project_root().join("docs").join("assets"),
        "docs assets root",
    )
}

/// Get the path for an example output file.
///
/// Creates the output directory if it doesn't exist.
///
/// # Arguments
/// * `filename` - The name of the output file (e.g., "line_plot.png")
///
/// # Returns
/// Full path to the output file in `generated/examples/`
///
/// # Example
/// ```ignore
/// let path = example_output_path("my_example_plot.png");
/// plot.save(&path)?;
/// ```
#[allow(dead_code)]
pub fn example_output_path(filename: &str) -> PathBuf {
    let output_dir = ensure_dir(
        generated_root().join("examples"),
        "generated examples output",
    );
    output_dir.join(filename)
}

/// Get the path for an example output file in a subdirectory.
///
/// Creates the subdirectory if it doesn't exist.
///
/// # Arguments
/// * `subdir` - Subdirectory name (e.g., "performance", "basic")
/// * `filename` - The name of the output file
///
/// # Returns
/// Full path to the output file in `generated/examples/<subdir>/`
#[allow(dead_code)]
pub fn example_output_path_in(subdir: &str, filename: &str) -> PathBuf {
    let output_dir = ensure_dir(
        generated_root().join("examples").join(subdir),
        "generated example output subdirectory",
    );
    output_dir.join(filename)
}

/// Get the path for a committed README-facing asset under `docs/assets/readme/`.
#[allow(dead_code)]
pub fn readme_asset_path(filename: &str) -> PathBuf {
    ensure_dir(
        docs_assets_root().join("readme"),
        "docs readme asset output",
    )
    .join(filename)
}

/// Get the path for a committed rustdoc-facing asset under `docs/assets/rustdoc/`.
#[allow(dead_code)]
pub fn rustdoc_asset_path(filename: &str) -> PathBuf {
    ensure_dir(
        docs_assets_root().join("rustdoc"),
        "docs rustdoc asset output",
    )
    .join(filename)
}

/// Get the path for a committed Rust gallery asset under
/// `docs/assets/gallery/rust/<category>/`.
#[allow(dead_code)]
pub fn rust_gallery_asset_path(category: &str, filename: &str) -> PathBuf {
    ensure_dir(
        docs_assets_root()
            .join("gallery")
            .join("rust")
            .join(category),
        "docs Rust gallery asset output",
    )
    .join(filename)
}