Error Handling

  • A closure which is called when Orion encounters a non-recoverable error.

    Important

    The closure must terminate the program, as implied by the Never return value.

    Declaration

    Swift

    public typealias OrionErrorHandler = (
    _ message: @autoclosure () -> String,
    _ file: StaticString,
    _ line: UInt
) -> Never

    Parameters

    message

    The error message.
    file

    The file associated with the error.
    line

    The line number associated with the error.
    Show on GitHub

  • Updates the OrionErrorHandler which is called when Orion encounters a non-recoverable error.

    The default error handler is fatalError.

    Warning

    This function is thread-safe but not reentrant. Do not call updateOrionErrorHandler(_:) or orionError(_:file:line:) inside the update block or the returned error handler.

    Example

    updateOrionErrorHandler { old in
    return { message, file, line in
        let str = message()
        // do something with str, file, line
        old(str, file, line)
    }
}

    Declaration

    Swift

    public func updateOrionErrorHandler(
    _ update: (_ previous: @escaping OrionErrorHandler) -> OrionErrorHandler
)

    Parameters

    update

    A closure which is passed the previous error handler and returns an updated handler.
    previous

    The previous error handler. You may want to call this at the end of your error handler closure.
    Show on GitHub

  • Raises an unrecoverable error within an Orion-related subsystem, and stops execution. Do not call this outside Orion code.

    The default behavior is to forward all arguments to fatalError. This behavior can be modified using updateOrionErrorHandler(_:).

    Warning

    This function is thread-safe but not reentrant. Do not call orionError(_:file:line:) or updateOrionErrorHandler(_:) inside the message autoclosure.

    Declaration

    Swift

    public func orionError(
    _ message: @autoclosure () -> String,
    file: StaticString = #file,
    line: UInt = #line
) -> Never

    Parameters

    message

    The error message.
    file

    The file name associated with the error. Defaults to the file in which orionError(_:file:line:) was called.
    line

    The line number associated with the error. Defaults to the line number on which orionError(_:file:line:) was called.
    Show on GitHub