module Fiber::Annotation

A mechanism for annotating fibers.

Constants

VERSION

Attributes

annotation [RW]

Get the current annotation. @returns [Object] The current annotation.

Public Class Methods

new (annotation: nil, **options, &block)

Source

# File vendor/bundle/ruby/3.4.0/gems/fiber-annotation-0.2.0/lib/fiber/annotation.rb, line 13
def initialize(annotation: nil, **options, &block)
        @annotation = annotation
        super(**options, &block)
end

Annotate the current fiber with the given annotation. @parameter annotation [Object] The annotation to set.

Calls superclass method

Public Instance Methods

annotate (annotation) { || ... }

Source

# File vendor/bundle/ruby/3.4.0/gems/fiber-annotation-0.2.0/lib/fiber/annotation.rb, line 31
def annotate(annotation)
        if block_given?
                raise "Cannot annotation a different fiber!" unless Fiber.current == self
                
                begin
                        current_annotation = @annotation
                        @annotation = annotation
                        return yield
                ensure
                        @annotation = current_annotation
                end
        else
                @annotation = annotation
        end
end

Annotate the current fiber with the given annotation.

If a block is given, the annotation is set for the duration of the block and then restored to the previous value.

The block form of this method should only be invoked on the current fiber.

@parameter annotation [Object] The annotation to set. @yields {} The block to execute with the given annotation. @returns [Object] The return value of the block.