Class: OpenTracing::Carrier

Inherits:
Object
  • Object
show all
Defined in:
lib/opentracing/carrier.rb

Overview

Carriers are used for inject and extract operations. A carrier should be a Hash or hash-like object. At a minimum, it should implement ‘[]`, `[]=`, and `each` shown here.

Instance Method Summary collapse

Instance Method Details

#[](key) ⇒ String

retrieves a value by the given key

Parameters:

  • key (String) —

    key to retrieve the value

Returns:

  • (String) —

    the desired value



9
 
# File 'lib/opentracing/carrier.rb', line 9

def [](key); end

#[]=(key, value) ⇒ Object

[]= sets the value for the given key

Parameters:

  • key (String) —

    key to set

  • value (String) —

    value to set



14
 
# File 'lib/opentracing/carrier.rb', line 14

def []=(key, value); end

#each {|key, value| ... } ⇒ Object

each iterates over every key-value pair in the carrier

Yields:

  • (key, value)

Yield Parameters:

  • key (String) —

    the key of the tuple

  • value (String) —

    the value of the tuple



20
 
# File 'lib/opentracing/carrier.rb', line 20

def each(&block); end