class Console::Format::Safe

A safe format for converting objects to strings.

Handles issues like circular references and encoding errors.

Public Class Methods

new (format: ::JSON, limit: 8, encoding: ::Encoding::UTF_8)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/format/safe.rb, line 20
def initialize(format: ::JSON, limit: 8, encoding: ::Encoding::UTF_8)
        @format = format
        @limit = limit
        @encoding = encoding
end

Create a new safe format.

@parameter format [JSON] The format to use for serialization. @parameter limit [Integer] The maximum depth to recurse into objects. @parameter encoding [Encoding] The encoding to use for strings.

Public Instance Methods

dump (object)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/format/safe.rb, line 30
def dump(object)
        @format.dump(object, @limit)
rescue SystemStackError, StandardError => error
        @format.dump(safe_dump(object, error))
end

Dump the given object to a string.

@parameter object [Object] The object to dump. @returns [String] The dumped object.