class Exception

Gibt ein Ausnahmeobjekt derselben Klasse wie self zurück; nützlich zum Erstellen einer ähnlichen Ausnahme, aber mit einer anderen Nachricht.

Mit message nil wird self zurückgegeben

x0 = StandardError.new('Boom') # => #<StandardError: Boom>
x1 = x0.exception              # => #<StandardError: Boom>
x0.__id__ == x1.__id__         # => true

Mit einem string-konvertierbaren Objekt message (auch dem gleichen wie die ursprüngliche Nachricht) wird ein neues Ausnahmeobjekt zurückgegeben, dessen Klasse dieselbe wie self ist und dessen Nachricht die gegebene message ist

x1 = x0.exception('Boom') # => #<StandardError: Boom>
x0..equal?(x1)            # => false

Siehe as_json.

Gibt ein neues Ausnahmeobjekt zurück.

Die angegebene message sollte ein string-konvertierbares Objekt sein; siehe Methode message; wenn nicht angegeben, ist die Nachricht der Klassenname der neuen Instanz (was der Name einer Unterklasse sein kann)

Beispiele

Exception.new         # => #<Exception: Exception>
LoadError.new         # => #<LoadError: LoadError> # Subclass of Exception.
Exception.new('Boom') # => #<Exception: Boom>

Gibt true zurück, wenn Ausnahme-Nachrichten an ein Terminalgerät gesendet werden.

Gibt zurück, ob object dieselbe Klasse wie self hat und seine message und backtrace gleich denen von self sind.

Die Methoden Exception#as_json und Exception.json_create können verwendet werden, um ein Exception-Objekt zu serialisieren und zu deserialisieren; siehe Marshal.

Die Methode Exception#as_json serialisiert self und gibt einen 2-elementigen Hash zurück, der self repräsentiert

require 'json/add/exception'
x = Exception.new('Foo').as_json # => {"json_class"=>"Exception", "m"=>"Foo", "b"=>nil}

Die Methode JSON.create deserialisiert einen solchen Hash und gibt ein Exception-Objekt zurück

Exception.json_create(x) # => #<Exception: Foo>

Gibt den Backtrace (die Liste der Code-Positionen, die zu der Ausnahme geführt haben) als Array von Strings zurück.

Beispiel (angenommen, der Code ist in der Datei namens t.rb gespeichert)

def division(numerator, denominator)
  numerator / denominator
end

begin
  division(1, 0)
rescue => ex
  p ex.backtrace
  # ["t.rb:2:in 'Integer#/'", "t.rb:2:in 'Object#division'", "t.rb:6:in '<main>'"]
  loc = ex.backtrace.first
  p loc.class
  # String
end

Der von dieser Methode zurückgegebene Wert kann beim Auslösen (siehe Kernel#raise) oder während der zwischenzeitlichen Behandlung durch set_backtrace angepasst werden.

Siehe auch backtrace_locations, das denselben Wert als strukturierte Objekte bereitstellt. (Beachten Sie jedoch, dass zwei Werte möglicherweise nicht übereinstimmen, wenn Backtraces manuell angepasst werden.)

Siehe Backtraces.

Gibt den Backtrace (die Liste der Code-Positionen, die zu der Ausnahme geführt haben) als Array von Thread::Backtrace::Location-Instanzen zurück.

Beispiel (angenommen, der Code ist in der Datei namens t.rb gespeichert)

def division(numerator, denominator)
  numerator / denominator
end

begin
  division(1, 0)
rescue => ex
  p ex.backtrace_locations
  # ["t.rb:2:in 'Integer#/'", "t.rb:2:in 'Object#division'", "t.rb:6:in '<main>'"]
  loc = ex.backtrace_locations.first
  p loc.class
  # Thread::Backtrace::Location
  p loc.path
  # "t.rb"
  p loc.lineno
  # 2
  p loc.label
  # "Integer#/"
end

Der von dieser Methode zurückgegebene Wert kann beim Auslösen (siehe Kernel#raise) oder während der zwischenzeitlichen Behandlung durch set_backtrace angepasst werden.

Siehe auch backtrace, das denselben Wert als Array von Strings bereitstellt. (Beachten Sie jedoch, dass zwei Werte möglicherweise nicht übereinstimmen, wenn Backtraces manuell angepasst werden.)

Siehe Backtraces.

Gibt den vorherigen Wert der globalen Variablen $! zurück, der nil sein kann (siehe Globale Variablen)

begin
  raise('Boom 0')
rescue => x0
  puts "Exception: #{x0};  $!: #{$!};  cause: #{x0.cause.inspect}."
  begin
    raise('Boom 1')
  rescue => x1
    puts "Exception: #{x1};  $!: #{$!};  cause: #{x1.cause}."
    begin
      raise('Boom 2')
    rescue => x2
      puts "Exception: #{x2};  $!: #{$!};  cause: #{x2.cause}."
    end
  end
end

Ausgabe

Exception: Boom 0;  $!: Boom 0;  cause: nil.
Exception: Boom 1;  $!: Boom 1;  cause: Boom 0.
Exception: Boom 2;  $!: Boom 2;  cause: Boom 1.

Gibt den Nachrichtentext mit Erweiterungen zurück

• Enthält den Namen der Ausnahme-Klasse in der ersten Zeile.

• Wenn der Wert des Schlüsselworts highlight true ist, werden fette und unterstrichene ANSI-Codes (siehe unten) zur Verbesserung der Darstellung der Nachricht enthalten.

Beispiele

begin
  1 / 0
rescue => x
  p x.message
  p x.detailed_message                  # Class name added.
  p x.detailed_message(highlight: true) # Class name, bolding, and underlining added.
end

Ausgabe

"divided by 0"
"divided by 0 (ZeroDivisionError)"
"\e[1mdivided by 0 (\e[1;4mZeroDivisionError\e[m\e[1m)\e[m"

Diese Methode wird von einigen Gems in der Ruby-Standardbibliothek überschrieben, um Informationen hinzuzufügen

• DidYouMean::Correctable#detailed_message.

• ErrorHighlight::CoreExt#detailed_message.

• SyntaxSuggest#detailed_message.

Eine überschreibende Methode muss tolerant gegenüber übergebenen Schlüsselwortargumenten sein, die enthalten können (aber nicht darauf beschränkt sind)

• :highlight.

• :did_you_mean.

• :error_highlight.

• :syntax_suggest.

Eine überschreibende Methode sollte auch vorsichtig mit ANSI-Code-Verbesserungen sein; siehe Nachrichten.

Gibt ein Ausnahmeobjekt derselben Klasse wie self zurück; nützlich zum Erstellen einer ähnlichen Ausnahme, aber mit einer anderen Nachricht.

Mit message nil wird self zurückgegeben

x0 = StandardError.new('Boom') # => #<StandardError: Boom>
x1 = x0.exception              # => #<StandardError: Boom>
x0.__id__ == x1.__id__         # => true

Mit einem string-konvertierbaren Objekt message (auch dem gleichen wie die ursprüngliche Nachricht) wird ein neues Ausnahmeobjekt zurückgegeben, dessen Klasse dieselbe wie self ist und dessen Nachricht die gegebene message ist

x1 = x0.exception('Boom') # => #<StandardError: Boom>
x0..equal?(x1)            # => false

Gibt eine erweiterte Nachricht zurück

• Enthält den Namen der Ausnahme-Klasse.

• Wenn der Wert des Schlüsselworts highlight true ist (nicht nil oder false), werden fette ANSI-Codes (siehe unten) zur Verbesserung der Darstellung der Nachricht enthalten.

• Enthält den Backtrace

  • Wenn der Wert des Schlüsselworts order :top (Standard) ist, werden die Fehlermeldung und der innerste Backtrace-Eintrag zuerst aufgelistet.

  • Wenn der Wert des Schlüsselworts order :bottom ist, werden die Fehlermeldung und der innerste Eintrag zuletzt aufgelistet.

Beispiel

def baz
  begin
    1 / 0
  rescue => x
    pp x.message
    pp x.full_message(highlight: false).split("\n")
    pp x.full_message.split("\n")
  end
end
def bar; baz; end
def foo; bar; end
foo

Ausgabe

"divided by 0"
["t.rb:3:in 'Integer#/': divided by 0 (ZeroDivisionError)",
 "\tfrom t.rb:3:in 'Object#baz'",
 "\tfrom t.rb:10:in 'Object#bar'",
 "\tfrom t.rb:11:in 'Object#foo'",
 "\tfrom t.rb:12:in '<main>'"]
["t.rb:3:in 'Integer#/': \e[1mdivided by 0 (\e[1;4mZeroDivisionError\e[m\e[1m)\e[m",
 "\tfrom t.rb:3:in 'Object#baz'",
 "\tfrom t.rb:10:in 'Object#bar'",
 "\tfrom t.rb:11:in 'Object#foo'",
 "\tfrom t.rb:12:in '<main>'"]

Eine überschreibende Methode sollte vorsichtig mit ANSI-Code-Verbesserungen sein; siehe Nachrichten.

Gibt eine String-Repräsentation von self zurück.

x = RuntimeError.new('Boom')
x.inspect # => "#<RuntimeError: Boom>"
x = RuntimeError.new
x.inspect # => "#<RuntimeError: RuntimeError>"

Gibt to_s zurück.

Siehe Nachrichten.

Setzt den Backtrace-Wert für self; gibt den gegebenen value zurück.

Der value kann sein

• ein Array von Thread::Backtrace::Location;

• ein Array von String-Instanzen;

• eine einzelne String-Instanz; oder

• nil.

Die Verwendung eines Arrays von Thread::Backtrace::Location ist die konsistenteste Option: Sie setzt sowohl backtrace als auch backtrace_locations. Sie sollte bevorzugt werden, wenn möglich. Das passende Array von Speicherorten kann von Kernel#caller_locations bezogen, von einer anderen Ausnahme kopiert oder einfach auf das angepasste Ergebnis der backtrace_locations der aktuellen Ausnahme gesetzt werden.

require 'json'

def parse_payload(text)
  JSON.parse(text)  # test.rb, line 4
rescue JSON::ParserError => ex
  ex.set_backtrace(ex.backtrace_locations[2...])
  raise
end

parse_payload('{"wrong: "json"')
# test.rb:4:in 'Object#parse_payload': unexpected token at '{"wrong: "json"' (JSON::ParserError)
#
# An error points to the body of parse_payload method,
# hiding the parts of the backtrace related to the internals
# of the "json" library

# The error has both #backtace and #backtrace_locations set
# consistently:
begin
  parse_payload('{"wrong: "json"')
rescue => ex
  p ex.backtrace
  # ["test.rb:4:in 'Object#parse_payload'", "test.rb:20:in '<main>'"]
  p ex.backtrace_locations
  # ["test.rb:4:in 'Object#parse_payload'", "test.rb:20:in '<main>'"]
end

Wenn der gewünschte Stapel von Speicherorten nicht verfügbar ist und von Grund auf neu aufgebaut werden soll, kann ein Array von Strings oder ein einzelner String verwendet werden. In diesem Fall wird nur backtrace beeinflusst.

def parse_payload(text)
  JSON.parse(text)
rescue JSON::ParserError => ex
  ex.set_backtrace(["dsl.rb:34", "framework.rb:1"])
  # The error have the new value in #backtrace:
  p ex.backtrace
  # ["dsl.rb:34", "framework.rb:1"]

  # but the original one in #backtrace_locations
  p ex.backtrace_locations
  # [".../json/common.rb:221:in 'JSON::Ext::Parser.parse'", ...]
end

parse_payload('{"wrong: "json"')

Das Aufrufen von set_backtrace mit nil löscht backtrace, beeinflusst aber nicht backtrace_locations

def parse_payload(text)
  JSON.parse(text)
rescue JSON::ParserError => ex
  ex.set_backtrace(nil)
  p ex.backtrace
  # nil
  p ex.backtrace_locations
  # [".../json/common.rb:221:in 'JSON::Ext::Parser.parse'", ...]
end

parse_payload('{"wrong: "json"')

Beim erneuten Auslösen einer solchen Ausnahme werden sowohl backtrace als auch backtrace_locations auf den Ort des erneuten Auslösens gesetzt.

def parse_payload(text)
  JSON.parse(text)
rescue JSON::ParserError => ex
  ex.set_backtrace(nil)
  raise # test.rb, line 7
end

begin
  parse_payload('{"wrong: "json"')
rescue => ex
  p ex.backtrace
  # ["test.rb:7:in 'Object#parse_payload'", "test.rb:11:in '<main>'"]
  p ex.backtrace_locations
  # ["test.rb:7:in 'Object#parse_payload'", "test.rb:11:in '<main>'"]
end

Siehe Backtraces.

Gibt einen JSON-String zurück, der self repräsentiert

require 'json/add/exception'
puts Exception.new('Foo').to_json

Ausgabe

{"json_class":"Exception","m":"Foo","b":null}

Gibt eine String-Repräsentation von self zurück.

x = RuntimeError.new('Boom')
x.to_s # => "Boom"
x = RuntimeError.new
x.to_s # => "RuntimeError"