123456789_123456789_123456789_123456789_123456789_

Module: ActiveSupport::Ractors

Do not use. This module is for internal use only.

Overview

Shims for Ractor shareability methods so framework code can call them unconditionally regardless of the Ruby version.

Class Attribute Summary

Class Method Summary

Autoload - Extended

autoload, autoload_at, autoload_under, eager_autoload, eager_load!

Class Attribute Details

.main? (readonly)

See additional method definition at line 108.

[ GitHub ] 

  


# File 'activesupport/lib/active_support/ractors.rb', line 149



def main?
  Ractor.main?
end


  








  

    .unshareable_proc_action   (rw)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 13



attr_accessor :unshareable_proc_action


  







Class Method Details



  

    .[](key)  
  



  

    
Returns the value stored under key in the current Ractor's local
storage. Returns nil when nothing has been stored under key yet.


Each Ractor has an isolated local storage, so values set in one Ractor
are not visible to any other.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 180



def self.[](key)
  Ractor.current[key]
end


  








  

    .[]=(key, value)  
  



  

    
Stores value under key in the current Ractor's local storage.
The value is only visible to the current Ractor, and other
Ractors have their own independent storage.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 187



def self.[]=(key, value)
  Ractor.current[key] = value
end


  








  

    .make_shareable(obj, copy: false)  
  



  

    
Makes obj Ractor-shareable by delegating to Ractor.make_shareable.


The copy: option is forwarded unchanged. On Ruby versions without
Ractor.make_shareable, this shim returns obj unchanged.


See additional method definition at line 116.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 157



def make_shareable(...)
  Ractor.make_shareable(...)
end


  








  

    .on_main(obj = nil, &block)  
  



  

    
See additional method definition at line 98.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 153



def on_main(obj = nil, &block)
  if Ractor.main?
    obj.instance_eval(&block)
  else
    require "ractor/dispatch"
    shareable_block = Ractor.shareable_proc(&block)
    Ractor::Dispatch.main.run { obj.instance_eval(&shareable_block) }
  end
end


  








  

    .shareable?(obj)  ⇒ Boolean 
  



  

    
Returns whether obj is Ractor-shareable by delegating to
Ractor.shareable?.


On Ruby versions without Ractor.shareable?, this shim returns obj
unchanged.


See additional method definition at line 125.

  





  


  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 161



def shareable?(obj)
  Ractor.shareable?(obj)
end


  








  

    .shareable_lambda(self: nil, &block)  
  



  

    
Returns a Ractor-shareable lambda by delegating to
Ractor.shareable_lambda.


The optional self: value is forwarded as the lambda's receiver. On Ruby
versions without Ractor.shareable_lambda, this shim returns the block
unchanged.


See additional method definition at line 144.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 169



def shareable_lambda(...)
  Ractor.shareable_lambda(...)
end


  








  

    .shareable_proc(self: nil, &block)  
  



  

    
Returns a Ractor-shareable proc by delegating to Ractor.shareable_proc.


The optional self: value is forwarded as the proc's receiver. On Ruby
versions without Ractor.shareable_proc, this shim returns the block
unchanged.


See additional method definition at line 134.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 165



def shareable_proc(...)
  Ractor.shareable_proc(...)
end


  








  

    .store_if_absent(key, &block)  
  



  

    
Returns the value stored under key in the current Ractor's local
storage, running block to compute and store it on first access, by
delegating to Ractor.store_if_absent. Concurrent threads in the
same Ractor initialize the value only once.


See additional method definition at line 196.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 206



def self.store_if_absent(key, &block)
  Ractor.store_if_absent(key, &block)
end


  








  

    .try_make_shareable(obj)  
  



  

    
Attempt to make an object shareable. If successful, a shareable object is returned.
If a Ractor::IsolationError is raised, the outcome will depend on how
the user's application configuration:


:raise - The error is raised
:warn  - A deprecation warning is triggered and the original unshareable object is returned.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 76



def try_make_shareable(obj, **)
  return obj unless unshareable_proc_action

  make_shareable(obj, **)
rescue Ractor::IsolationError
  case unshareable_proc_action
  when :raise
    raise
  when :warn
    ActiveSupport.deprecator.warn(<<~MSG)
      Rails attempted to make an object from your application Ractor shareable but a Ractor
      Isolation error was raised. The object being returned is not Ractor safe and a runtime
      error may occur anytime during the request lifecycle.

      #{obj.inspect}
    MSG

    obj
  end
end


  








  

    .try_shareable_lambda(receiver, &block)  
  



  

    
Attempt to make a lambda shareable, bound to receiver as its self.
If successful, a shareable lambda is returned. If a Ractor::IsolationError
is raised, the outcome will depend on the user's application configuration:


:raise - The error is raised
:warn  - A deprecation warning is triggered and the original unshareable lambda is returned.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 49



def try_shareable_lambda(receiver, &block)
  return block unless unshareable_proc_action

  shareable_lambda(self: receiver, &block)
rescue Ractor::IsolationError
  case unshareable_proc_action
  when :raise
    raise
  when :warn
    ActiveSupport.deprecator.warn(<<~MSG)
      Rails attempted to make a lambda from your application Ractor shareable but a Ractor
      Isolation error was raised. The lambda being returned is not Ractor safe and a runtime
      error may occur anytime during the request lifecycle.

      #{block.inspect}
    MSG

    block
  end
end


  








  

    .try_shareable_proc(proc = nil, &block)  
  



  

    
Attempt to make a proc shareable. If successful, a shareable proc is returned.
If a Ractor::IsolationError is raised, the outcome will depend on how
the user's application configuration:


:raise - The error is raised
:warn  - A deprecation warning is triggered and the original unshareable proc is returned.

  



  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/ractors.rb', line 21



def try_shareable_proc(proc = nil, &block)
  proc ||= block
  return proc unless unshareable_proc_action

  shareable_proc(&proc)
rescue Ractor::IsolationError
  case unshareable_proc_action
  when :raise
    raise
  when :warn
    ActiveSupport.deprecator.warn(<<~MSG)
      Rails attempted to make a Proc from your application Ractor shareable but a Ractor
      Isolation error was raised. The proc being returned is not Ractor safe and a runtime
      error may occur anytime during the request lifecycle.

      #{proc.inspect}
    MSG

    proc
  end
end