123456789_123456789_123456789_123456789_123456789_

Class: JSON::Fragment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Struct
Instance Chain:
self, Struct
Inherits: Struct
Defined in: ext/json/lib/json/common.rb

Overview

Fragment of ::JSON document that is to be included as is:

fragment = JSON::Fragment.new("[1, 2, 3]")
JSON.generate({ count: 3, items: fragments })

This allows to easily assemble multiple ::JSON fragments that have been persisted somewhere without having to parse them nor resorting to string interpolation.

Note: no validation is performed on the provided string. It is the responsibility of the caller to ensure the string contains valid ::JSON.

Class Method Summary

Instance Attribute Summary

  • #json rw

    Fragment of ::JSON document that is to be included as is:

Instance Method Summary

Constructor Details

.new(json) ⇒ Fragment

[ GitHub ] 

  


# File 'ext/json/lib/json/common.rb', line 233



def initialize(json)
  unless string = String.try_convert(json)
    raise TypeError, " no implicit conversion of #{json.class} into String"
  end

  super(string)
end


  







Instance Attribute Details



  

    #json   (rw)
  



  

    
Fragment of ::JSON document that is to be included as is:


fragment = JSON::Fragment.new("[1, 2, 3]")
JSON.generate({ count: 3, items: fragments })


This allows to easily assemble multiple ::JSON fragments that have
been persisted somewhere without having to parse them nor resorting
to string interpolation.


Note: no validation is performed on the provided string. It is the
responsibility of the caller to ensure the string contains valid ::JSON.

  



  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 232



Fragment = Struct.new(:json)


  







Instance Method Details



  

    #to_json(state = nil)  
  

  [ GitHub ]


  

  


# File 'ext/json/lib/json/common.rb', line 241



def to_json(state = nil, *)
  json
end