DebuggableError

Topics

Instance Properties

• var documentationLinks: [String]
  An array of string URLs linking to documentation pertaining to the error.
• var fullIdentifier: String
• var gitHubIssues: [String]
  An array of string URLs linking to related issues on Vapor’s GitHub repo.
• var identifier: String
  Some unique identifier for this specific error. This will be used to create the identifier property. Do NOT use String(reflecting: self) or String(describing: self) or there will be infinite recursion
• var logLevel: Logger.Level
  Which log level this error should report as. Defaults to .warning.
• var possibleCauses: [String]
  A String array describing the possible causes of the error.
• var reason: String
  The reason for the error. Usually one sentence (that should end with a period).
• var source: ErrorSource?
  Optional source for this error
• var stackOverflowQuestions: [String]
  An array of string URLs linking to related Stack Overflow questions.
• var stackTrace: StackTrace?
  Stack trace from which this error originated (must set this from the error’s init)
• var suggestedFixes: [String]
  A String array listing some common fixes for the error.

Instance Methods

• func debuggableHelp(format: HelpFormat) -> String
  A computed property returning a String that encapsulates why the error occurred, suggestions on how to fix the problem, and resources to consult in debugging (if these are available).

Type Properties

• static var readableName: String
  A readable name for the error’s Type. This is usually similar to the Type name of the error with spaces added. This will normally be printed proceeding the error’s reason.
• static var typeIdentifier: String
  A unique identifier for the error’s Type.