Struct IndicatorDefinition 

pub struct IndicatorDefinition {

    pub display_name: String,
    pub author: Option<IndicatorAuthor>,
    pub description: Option<String>,
    pub source: Option<String>,
    pub sourceable: bool,
    pub inputs: Vec<IndicatorInputRequirement>,
    pub source_inputs: Vec<IndicatorSourceInput>,
    pub attachment_mode: IndicatorAttachmentMode,
    pub outputs: Vec<OutputChannelSpec>,
    pub style_slots: Vec<IndicatorColorSpec>,
    pub region_style_slots: Vec<String>,
    pub mark_specs: Vec<IndicatorMarkSpec>,
    pub segment_specs: Vec<IndicatorSegmentSpec>,
    pub overlay_channels: Vec<IndicatorOverlayChannelSpec>,
    pub fill_specs: Vec<IndicatorFillSpec>,
    pub panel_recipe: IndicatorPanelRecipe,
}

Fields

display_name: String

author: Option<IndicatorAuthor>

description: Option<String>

source: Option<String>

sourceable: bool

inputs: Vec<IndicatorInputRequirement>

source_inputs: Vec<IndicatorSourceInput>

attachment_mode: IndicatorAttachmentMode

outputs: Vec<OutputChannelSpec>

style_slots: Vec<IndicatorColorSpec>

region_style_slots: Vec<String>

mark_specs: Vec<IndicatorMarkSpec>

segment_specs: Vec<IndicatorSegmentSpec>

overlay_channels: Vec<IndicatorOverlayChannelSpec>

fill_specs: Vec<IndicatorFillSpec>

panel_recipe: IndicatorPanelRecipe

Implementations

impl IndicatorDefinition

pub fn new( display_name: impl Into<String>, inputs: impl Into<Vec<IndicatorInputRequirement>>, outputs: impl Into<Vec<OutputChannelSpec>>, panel_recipe: IndicatorPanelRecipe, ) -> Self

pub fn with_style_slots( self, style_slots: impl Into<Vec<IndicatorColorSpec>>, ) -> Self

pub fn with_region_style_slots(self, slots: impl Into<Vec<String>>) -> Self

pub fn with_source_inputs( self, source_inputs: impl Into<Vec<IndicatorSourceInput>>, ) -> Self

pub fn with_sourceable(self, sourceable: bool) -> Self

pub fn with_author(self, author: Option<IndicatorAuthor>) -> Self

pub fn with_description(self, description: Option<String>) -> Self

pub fn with_source(self, source: Option<String>) -> Self

pub fn with_attachment_mode( self, attachment_mode: IndicatorAttachmentMode, ) -> Self

pub fn with_display_specs( self, mark_specs: impl Into<Vec<IndicatorMarkSpec>>, overlay_channels: impl Into<Vec<IndicatorOverlayChannelSpec>>, fill_specs: impl Into<Vec<IndicatorFillSpec>>, ) -> Self

pub fn with_segment_specs( self, segment_specs: impl Into<Vec<IndicatorSegmentSpec>>, ) -> Self

pub fn output(&self, id: &str) -> Option<&OutputChannelSpec>

pub fn sourceable_numeric_output(&self, id: &str) -> Option<&OutputChannelSpec>

pub fn has_numeric_plot_layers(&self) -> bool

pub fn default_view(&self) -> &IndicatorPanelRecipe

pub fn output_layers(&self) -> &[IndicatorOutputLayerSpec]

pub fn segment_specs(&self) -> &[IndicatorSegmentSpec]

pub fn requires(&self, source: IndicatorInputSource) -> bool

pub fn uses(&self, source: IndicatorInputSource) -> bool

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

Trait Implementations

impl Clone for IndicatorDefinition

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndicatorDefinition

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

Formats the value using the given formatter.