Struct yy_boss::PipelineManager

pub struct PipelineManager { /* fields omitted */ }

Implementations

impl PipelineManager

pub fn pipelines(&self) -> &BTreeMap<String, Pipeline>

Returns a map of all the pipelines currently known.

pub fn pipeline(&self, pipeline_name: impl Into<String>) -> Option<&Pipeline>

Returns a specific pipeline by name, if it exists.

pub fn pipeline_destinations(
    &self,
    pipeline_name: impl Into<String>,
    source_name: impl Into<String>
) -> Option<&PipelineDesinations>

Gets all of the destinations for a given source within a given pipeline, if both the pipeline and a source within that pipeline exist.

pub fn add_pipeline(
    &mut self,
    name: impl Into<String>,
    sf: SerializationFormat
) -> Result<(), PipelineError>

Creates a pipeline. If a pipeline of that name already exists, an error is returned.

pub fn set_pipeline_serialization(
    &mut self,
    name: impl Into<String>,
    sf: SerializationFormat
) -> Result<(), PipelineError>

Changes the pipeline serialization format on a given pipeline.

If the pipeline doesn't exist, an error is returned.

pub fn add_source_to_pipeline(
    &mut self,
    pipeline_name: impl Into<String>,
    source_name: impl Into<String>
) -> Result<(), PipelineError>

Adds a source to a given pipeline.

If a pipeline doesn't exist, an error is returned.

pub fn add_destination_to_source<S: Into<String>>(
    &mut self,
    pipeline_name: S,
    source_name: S,
    destination_key: S,
    destination_value: FilesystemPath
) -> Result<(), PipelineError>

Adds a destination to a given source on a given pipeline.

If the pipeline doesn't exist or the source doesn't exist on the pipeline, an error is returned.

pub fn add_destination_to_source_rf<S: Into<String>>(
    &mut self,
    pipeline_name: S,
    source_name: S,
    destination_key: S,
    destination_value: FilesystemPath
)

Adds a destination to a given source on a given pipeline.

If any elements do not exist, they will be created. If a destination exists on a source/pipeline which already exists, it will be replaced and lost.

pub fn remove_pipeline(
    &mut self,
    pipeline_name: impl Into<String>
) -> Result<(), PipelineError>

Removes a given pipeline from the manager. If any sources are on the pipeline, they will be lost permanently!

If the pipeline does not exist, an error is returned.

pub fn remove_source_from_pipeline(
    &mut self,
    pipeline_name: impl Into<String>,
    source_name: impl Into<String>
) -> Result<(), PipelineError>

Removes a given source from a pipeline. If any destinations are in the source, it will be lost permanently!

If the pipeline does not exist, or if the source does not exist on the pipeline, an error is returned.

pub fn remove_destination_from_source(
    &mut self,
    pipeline_name: impl Into<String>,
    source_name: impl Into<String>,
    destination_name: &str
) -> Result<(), PipelineError>

Removes a given destination from a source.

If the pipeline does not exist, or if the source does not exist on the pipeline, or if the destination does not exist on the source, an error is returned.

Trait Implementations

impl Clone for PipelineManager

pub fn clone(&self) -> PipelineManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PipelineManager

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

Formats the value using the given formatter.

impl Default for PipelineManager

pub fn default() -> PipelineManager

Returns the "default value" for a type.

impl Eq for PipelineManager

impl PartialEq<PipelineManager> for PipelineManager

pub fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for PipelineManager