class JSON::TruffleRuby::Generator::State

This class is used to create State instances, that are use to hold data while generating a JSON text from a Ruby data structure.

Attributes

array_nl [RW]

This string is put at the end of a line that holds a JSON array.

as_json [R]

This proc converts unsupported types into native JSON types.

depth [R]

This integer returns the current depth data structure nesting in the generated JSON.

indent [RW]

This string is used to indent levels in the JSON text.

max_nesting [RW]

This integer returns the maximum level of data structure nesting in the generated JSON, max_nesting = 0 if no maximum is checked.

object_nl [RW]

This string is put at the end of a line that holds a JSON object (or Hash).

rfc8785 [W]

Controls whether RFC8785 (canonicalization) mode is enabled. Otherwise returns false.

script_safe [RW]

If this attribute is set to true, forward slashes will be escaped in all json strings.

sort_keys [R]

Controls key sorting in the generated JSON. If set to true, object keys are sorted by key lexicographically. If set to a Proc, it receives the entire Hash and must return a Hash with its pairs in the desired order.

space [RW]

This string is used to insert a space between the tokens in a JSON string.

space_before [RW]

This string is used to insert a space before the ‘:’ in JSON objects.

strict [RW]

If this attribute is set to true, attempting to serialize types not supported by the JSON spec will raise a JSON::GeneratorError

Public Class Methods

from_state (opts)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 126
def self.from_state(opts)
  if opts
    case
    when self === opts
      return opts.validate_rfc8785
    when opts.respond_to?(:to_hash)
      return new(opts.to_hash)
    when opts.respond_to?(:to_h)
      return new(opts.to_h)
    end
  end
  new
end

Creates a State object from opts, which ought to be Hash to create a new State instance configured by opts, something else to create an unconfigured instance. If opts is a State object, it is just returned.

generate (obj, opts = nil, io = nil)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 118
def self.generate(obj, opts = nil, io = nil)
  new(opts).generate(obj, io)
end

new (opts = nil)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 157
def initialize(opts = nil)
  @indent                = ''
  @space                 = ''
  @space_before          = ''
  @object_nl             = ''
  @array_nl              = ''
  @allow_nan             = false
  @ascii_only            = false
  @as_json               = false
  @depth                 = 0
  @buffer_initial_length = 1024
  @script_safe           = false
  @strict                = false
  @max_nesting           = 100
  @sort_keys             = false
  @allow_duplicate_key   = false
  @rfc8785               = false
  _configure(**opts) if opts
end

Instantiates a new State object, configured by opts.

opts can have the following keys:

indent: a string used to indent levels (default: ”),
space: a string that is put after, a : or , delimiter (default: ”),
space_before: a string that is put before a : pair delimiter (default: ”),
object_nl: a string that is put at the end of a JSON object (default: ”),
array_nl: a string that is put at the end of a JSON array (default: ”),
script_safe: true if U+2028, U+2029 and forward slash (/) should be escaped as to make the JSON object safe to interpolate in a script tag (default: false).
check_circular: is deprecated now, use the :max_nesting option instead,
max_nesting: sets the maximum level of data structure nesting in the generated JSON, max_nesting = 0 if no maximum should be checked.
allow_nan: true if NaN, Infinity, and -Infinity should be generated, otherwise an exception is thrown, if these values are encountered. This options defaults to false.

Public Instance Methods

allow_nan? ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 284
def allow_nan?
  @allow_nan
end

Returns true if NaN, Infinity, and -Infinity should be considered as valid JSON and output.

as_json= (value)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 197
def as_json=(value)
  raise FrozenError, "can't modify frozen #{self.class}: #{inspect}" if frozen?
  value = value.to_proc if !(Proc === value) && value.respond_to?(:to_proc)
  unless Proc === value
    raise TypeError, "as_json must be a Proc"
  end
  @as_json = value
end

ascii_only? ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 290
def ascii_only?
  @ascii_only
end

Returns true, if only ASCII characters should be generated. Otherwise returns false.

check_circular? ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 278
def check_circular?
  !@max_nesting.zero?
end

Returns true, if circular data structures are checked, otherwise returns false.

configure (options)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 329
def configure(options)
  unless Hash == options
    if options.respond_to?(:to_hash)
      options = options.to_hash
    elsif options.respond_to?(:to_h)
      options = options.to_h
    end
  end
  _configure(**options)
end

Configure this State instance with the Hash opts, and return itself.

Also aliased as: merge

depth= (depth)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 262
def depth=(depth)
  if depth.negative?
    raise ArgumentError, "depth must be >= 0 (got #{depth})"
  end
  @depth = depth
end

generate (obj, anIO = nil)

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 414
def generate(obj, anIO = nil)
  return dup.generate(obj, anIO) if frozen?

  depth = @depth
  validate_rfc8785
  if @indent.empty? and @space.empty? and @space_before.empty? and @object_nl.empty? and @array_nl.empty? and
      !@ascii_only and !@script_safe and @max_nesting == 0 and (!@strict || Symbol === obj) and !@sort_keys
    result = generate_json(obj, ''.dup)
  else
    result = obj.to_json(self)
  end

  JSON::TruffleRuby::Generator.valid_utf8?(result) or raise GeneratorError.new(
    "source sequence #{result.inspect} is illegal/malformed utf-8",
    obj
  )
  if anIO
    anIO.write(result)
    anIO
  else
    result
  end
ensure
  @depth = depth unless frozen?
end

Generates a valid JSON document from object obj and returns the result. If no valid JSON document can be created this method raises a GeneratorError exception.

merge (options)

Alias for: configure

rfc8785? ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 307
def rfc8785?
  @rfc8785
end

Returns true, if RFC8785 (canonicalization) mode is enabled. Otherwise returns false.

script_safe? ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 295
def script_safe?
  @script_safe
end

Returns true, if forward slashes are escaped. Otherwise returns false.

strict? ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 302
def strict?
  @strict
end

Returns true, if strict mode is enabled. Otherwise returns false. Strict mode only allow serializing JSON native types: Hash, Array, String, Integer, Float, true, false and nil.

to_h ()

Source

# File vendor/bundle/ruby/4.0.0/gems/json-3.1.0/lib/json/truffle_ruby/generator.rb, line 387
def to_h
  {
    indent: @indent,
    space: @space,
    space_before: @space_before,
    object_nl: @object_nl,
    array_nl: @array_nl,
    as_json: @as_json,
    allow_nan: @allow_nan,
    ascii_only: @ascii_only,
    max_nesting: @max_nesting,
    script_safe: @script_safe,
    strict: @strict,
    depth: @depth,
    buffer_initial_length: @buffer_initial_length,
    sort_keys: @sort_keys,
    allow_duplicate_key: @allow_duplicate_key,
    rfc8785: @rfc8785,
  }
end

Returns the configuration instance variables as a hash, that can be passed to the configure method.

Also aliased as: to_hash

to_hash ()

Alias for: to_h