NodeType

enum NodeType : Int, Codable, Equatable

An enum for storing the node type state of the message associated with a print number.

Each case is used to specify formatting when displaying the associated message in the console.

  • The message should be displayed as a function name.

    The message will include the function name if the argument #function is supplied to the optional functionName parameter of the print(_:functionName:settings:) overload.

    If there is no argument supplied it will simply display the entity code, function symbol and function number.

    Declaration

    Swift

    case functionName = 0
  • The message should be displayed as the successful pass of a conditional if statement in the control flow.

    Declaration

    Swift

    case ifTrueCondition
  • The message should be displayed as failing to pass a conditional if statement and reaching a paired else clause in the control flow.

    Declaration

    Swift

    case elseCondition
  • The message should be displayed as the successful pass of a conditional if statement that has a negative or undesired outcome in the control flow.

    Declaration

    Swift

    case ifTrueConditionNegativeOutcome
  • The message should be displayed as failing to pass a conditional if statement and reaching a paired else clause that has a positive or desired outcome in the control flow.

    Declaration

    Swift

    case elseConditionPositiveOutcome
  • The message should be displayed as the successful match of a conditional switch statement case that has a positive or desired outcome in the control flow.

    Declaration

    Swift

    case caseTruePositiveOutcome
  • The message should be displayed as the successful match of a conditional switch statement case that has a negative or undesired outcome in the control flow.

    Declaration

    Swift

    case caseTrueNegativeOutcome
  • The message should be displayed as the successful pass of a conditional guard statement in the control flow.

    Declaration

    Swift

    case guardPass
  • The message should be displayed as failing to pass a conditional guard statement and reaching its associated else clause in the control flow.

    Declaration

    Swift

    case guardFail
  • The message should be displayed as signifying the execution of the do block of a do-catch statement after successfully attempting try on a function that throws an error in the control flow.

    Declaration

    Swift

    case doTryPass
  • The message should be displayed as signifying the execution of the catch block of a do-catch statement after unsuccessfully attempting try on a function that throws an error in the control flow.

    Declaration

    Swift

    case catchTryFail
  • The message should be displayed as a value or comment report.

    The message will be displayed as a value report if a value argument is supplied to the optional values parameter of the print(_:values:settings:) overload.

    If there is no argument supplied it will simply display the report event_description as a comment.

    If a value argument is supplied any value or values are displayed on subsequent lines in the console after the report description.

    Declaration

    Swift

    case valueReporter
  • The message should be displayed as an error report.

    The message will be displayed as an error report if the value argument supplied to the optional values parameter of the print(_:values:settings:) overload conforms to the ‘Error’ protocol.

    If an error argument is supplied the error is displayed on the following line in the console after the error report event_description.

    Note

    Note If the error conforms to LocalizedError the error will be displayed as a NSLocalizedString written for the specific custom error case. Otherwise the error will be described as the type name of the Error supplied to the values parameter.

    Alternatively the error description will be described if localizedDescription is called on the error as it is supplied to the values parameter.

    If there is no argument supplied it will simply display the error report event_description as a comment without actual error information.

    Declaration

    Swift

    case errorReporter