optionstratlib 0.17.2

OptionStratLib is a comprehensive Rust library for options trading and strategy development across multiple asset classes.
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

use serde::{Deserialize, Serialize};

/// Represents the visual style of a line in graphical elements.
///
/// This enum defines different line styles that can be used when drawing lines
/// in graphics contexts, charts, or UI elements.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[repr(u8)]
pub enum LineStyle {
    /// A continuous unbroken line (default style).
    #[default]
    Solid,
    /// A line composed of small dots.
    Dotted,
    /// A line composed of longer segments with gaps.
    Dashed,
}

/// Represents the color scheme used for visualizations.
///
/// This enum defines various color schemes that can be applied to charts, graphs,
/// or any visual elements that require color differentiation.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ColorScheme {
    /// Default color scheme, used when no specific scheme is selected.
    #[default]
    Default,

    /// Viridis color scheme - a perceptually uniform color map designed to be
    /// perceived by viewers with common forms of color blindness.
    Viridis,

    /// Plasma color scheme - a perceptually uniform color map with a purple-orange gradient.
    Plasma,

    /// Custom color scheme defined by a vector of color strings.
    /// Each string should represent a valid color (e.g., hex code, RGB, color name).
    Custom(Vec<String>),

    /// White color scheme - primarily white or light colors.
    White,

    /// High contrast color scheme - designed for maximum visibility and accessibility.
    HighContrast,
}

/// Defines the visual appearance of traces in plots.
///
/// This enum specifies how data points should be displayed in a visualization,
/// such as connecting points with lines, showing individual markers, or both.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[repr(u8)]
pub enum TraceMode {
    /// Display points connected by lines only.
    #[default]
    Lines,
    /// Display individual markers only without connecting lines.
    Markers,
    /// Display both lines connecting points and individual markers.
    LinesMarkers,
    /// Display text labels at points.
    TextLabels,
}

/// Represents different types of plots that can be generated.
///
/// This enum defines the various plot visualization types supported by the system.
/// Each variant corresponds to a specific visualization method for data representation.
///
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[repr(u8)]
pub enum PlotType {
    /// 2D line plot
    #[default]
    Line2D,
    /// 2D scatter plot with individual points
    Scatter2D,
    /// 3D surface plot for visualizing 3D data
    Surface3D,
    /// Heat map visualization for representing data density or intensity
    Heatmap,
}