Skip to content

cvw::pipe_ops

Namespace containing operator| overloads for pipeline chaining. More...

Functions

Name
template <is_pixel_format F,typename Step &gt;
auto
**[operator
template <is_pixel_format F,typename Step &gt;
auto
**[operator
template <typename Step &gt;
auto
**[operator

Detailed Description

Namespace containing operator| overloads for pipeline chaining.

Import pipe_ops into scope with using namespace [cvw::pipe_ops](namespacecvw_1_1pipe__ops.md); to enable the pipe syntax.

Functions Documentation

function operator|

cpp
template <is_pixel_format F,
typename Step >
auto operator|(
    Image<F> img,
    Step && step
)

Chains an Image through a step via operator|.

Parameters:

  • img Input image (moved into the step).
  • step Callable step to apply.

Template Parameters:

  • F Pixel format of the image.
  • Step Callable step type.

Return: Result of applying the step.

Since: 1.0.0

function operator|

cpp
template <is_pixel_format F,
typename Step >
auto operator|(
    expected< Image<F>, AlgorithmError > input,
    Step && step
)

Chains an Expected<Image> through a step with short-circuit.

Parameters:

  • input Expected image (may contain error).
  • step Callable step to apply.

Template Parameters:

  • F Pixel format of the image.
  • Step Callable step type.

Return: Result of applying the step, or the propagated error.

Since: 1.0.0

If the input contains an error, the step is skipped and the error propagates immediately.

function operator|

cpp
template <typename Step>
auto operator|(
    expected<void, AlgorithmError> input,
    Step && step
)

Chains an Expected<void> through a step with short-circuit.

Parameters:

  • input Expected void (may contain error).
  • step Callable step to apply.

Template Parameters:

  • Step Callable step type.

Return: Result of applying the step, or the propagated error.

Since: 1.0.0

Used after a sink step (e.g., save) to continue the pipeline.


Updated on 2026-05-17 at 13:22:38 +0000

Built with VitePress