Teek API Documentation

Teek::RactorStream Class

Simplified streaming API without pause/resume support. Uses Ractor on Ruby 4.x+, falls back to threads on 3.x.

Inherits: Object

Instance Methods ↑

cancel

View source ▼ 
def cancel
  @impl.stop
end
GitHub

initialize(app, data, &block)

Returns RactorStream — a new instance of RactorStream

View source ▼ 
def initialize(app, data, &block)
  # Ruby 4.x: use Ractor with shareable_proc for true parallelism
  # Ruby 3.x: use threads (Ractor mode not supported)
  if BackgroundWork::RACTOR_SUPPORTED
    shareable_block = Ractor.shareable_proc(&block)
    wrapped_block = Ractor.shareable_proc do |task, d|
      yielder = StreamYielder.new(task)
      shareable_block.call(yielder, d)
    end
    @impl = Teek::BackgroundRactor4x::BackgroundWork.new(app, data, &wrapped_block)
  else
    wrapped_block = proc do |task, d|
      yielder = StreamYielder.new(task)
      block.call(yielder, d)
    end
    @impl = Teek::BackgroundThread::BackgroundWork.new(app, data, &wrapped_block)
  end
end
GitHub

on_done(&block)

View source ▼ 
def on_done(&block)
  @impl.on_done(&block)
  self
end
GitHub

on_progress(&block)

View source ▼ 
def on_progress(&block)
  @impl.on_progress(&block)
  self
end
GitHub