module Quartz::Transferable

Overview

The Transferable module is used in Quartz as a marker interface to denote types that may be transmitted between two Ports through couplings. The common types included in the union Type can be transferred, but if you need to extend those types, Transferable marker module should be included.

Until crystal compiler is able to store virtual types as an ivar, we use this workaround (see crystal issue #1839).

Usage:

class MyType
  include Quartz::Transferable
  # ...
end

class SenderModel < Quartz::AtomicModel
  output :oport

  def output
    post MyType.new, on: :oport
  end
end

For existing types that are not included in the union Type, you can re-open its definition and include Transferable:

struct BigInt
  include Transferable
end

Direct including types

• Quartz::Coupleable

Defined in:

quartz/types.cr