class JSON::Coder
JSON::Coder
holds a parser and generator configuration.
module MyApp JSONC_CODER = JSON::Coder.new( allow_trailing_comma: true ) end MyApp::JSONC_CODER.load(document)
Public Class Methods
Source
# File ext/json/lib/json/common.rb, line 891 def initialize(options = nil, &as_json) if options.nil? options = { strict: true } else options = options.dup options[:strict] = true end options[:as_json] = as_json if as_json options[:create_additions] = false unless options.key?(:create_additions) @state = State.new(options).freeze @parser_config = Ext::Parser::Config.new(options) end
Argument options
, if given, contains a Hash of options for both parsing and generating. See Parsing Options, and Generating Options.
For generation, the strict: true
option is always set. When a Ruby object with no native JSON counterpart is encoutered, the block provided to the initialize method is invoked, and must return a Ruby object that has a native JSON counterpart:
module MyApp API_JSON_CODER = JSON::Coder.new do |object| case object when Time object.iso8601(3) else object # Unknown type, will raise end end end puts MyApp::API_JSON_CODER.dump(Time.now.utc) # => "2025-01-21T08:41:44.286Z"
Public Instance Methods
Source
# File ext/json/lib/json/common.rb, line 910 def dump(object, io = nil) @state.generate_new(object, io) end
Serialize the given object into a JSON document.
Also aliased as: generate
Source
# File ext/json/lib/json/common.rb, line 919 def load(source) @parser_config.parse(source) end
Parse the given JSON document and return an equivalent Ruby object.
Also aliased as: parse
Source
# File ext/json/lib/json/common.rb, line 928 def load_file(path) load(File.read(path, encoding: Encoding::UTF_8)) end
Parse the given JSON document and return an equivalent Ruby object.