Enumerations
The following enumerations are available globally.
-
An Enum namespace for constants that are used across different entities in the Clarity framework.
See moreDeclaration
Swift
enum PrintConstants
-
An enum for storing the general type of the value passed in a print statement.
The enum divides cases into one of the three generic collection types, a single type or none.
The type of value passed to the print statement is indeterminate therefore value element types are either
Any
orAnyHashable
.The general type of a value is all that is required to handle printing elements appropriately to the console (the purpose of the print statement values argument).
Note
EachPrintValueType
case is calculated from a messageNodeType
and not stored on the message itself.Declaration
Swift
enum PrintValueType
-
An enum for storing the print type of a message.
The components that are used to build a message string are determined by a combination of the message
NodeType
, user settings derived from JSON and any arguments passed to the associated print statement.PrintType
contains cases for all possible combinations and none.Note
ThePrintType
case is not stored on the message itself.Declaration
Swift
enum PrintType
-
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.
See moreDeclaration
Swift
enum NodeType : Int, Codable, Equatable
-
An enum for storing the function group state of the message associated with a print number.
Each case is used to specify the formatting of function name node types when displaying the associated message in the console.
Each case is assigned a single character value as an abbreviation of the case name. The values are the same used to specify the
FunctionType
of a message in the EntityLog JSON although the values are not directly bound.Note
The use of this feature is discretional and does not bind the function referenced in the source code to the group specified by a particular case: any case can be used for any group of function, mapped to signify an alternative group or the single default caseCustomFunc
can be used for all functions.The grouping of functions named in the enum is not intended to be an exhaustive list or the representation of an ideal demarcation.
The purpose of differential formatting according to function group is as an additional visual aid that makes it easier to spot anomalies or unexpected routes in the control flow. It is also designed to help developers gain understanding of the functionality of unfamiliar code.
See moreDeclaration
Swift
enum FunctionType : String, Codable, Equatable