error.fz

# This file is part of the Fuzion language implementation.
#
# The Fuzion language implementation is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License as published
# by the Free Software Foundation, version 3 of the License.
#
# The Fuzion language implementation is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
# License for more details.
#
# You should have received a copy of the GNU General Public License along with The
# Fuzion language implementation.  If not, see <https://www.gnu.org/licenses/>.


# -----------------------------------------------------------------------
#
#  Tokiwa Software GmbH, Germany
#
#  Source code of Fuzion standard library feature error
#
#  Author: Fridtjof Siebert (siebert@tokiwa.software)
#
# -----------------------------------------------------------------------

# error represents an error condition described by a message string
#
# NYI: Future versions of error might be equipped with a stack trace if
# debugging is enabled
#
public error (

  # the message describing the error. Should usually be a single line not
  # followed by a linefeed.
  #
  public msg String,

  # optional error code
  #
  public error_code option i64

  ) : property.equatable

is


  # converts error to a string
  #
  # returns "error: $msg" or "error(code=$error_code): $msg"
  #
  public redef as_string String =>
    error_code
      .bind x->
        "error(code=$x): $msg"
      .or_else "error: $msg"


  # equality
  #
  public fixed redef type.equality(x, y error) bool =>
    x.msg = y.msg && x.error_code = y.error_code


public error(msg String) error =>
  error msg nil