FormattingManagerService

struct FormattingManagerService : Codable, Equatable

A struct that is used as the top level container of a model used to decode Formatting JSON data.

The struct matches the structure of the Formatting JSON exactly and is not currently used to service a struct that models the JSON differently. It embeds nested structs representing objects in the JSON data.

Note

Note The struct uses a custom semantic naming system to name properties associated with key value pairs and their position in the JSON. This system was developed as an aid to correctly map each key to its position in the struct.

  • A struct of type OutcomeSymbols mapped to the outcome_symbols key in the Formatting JSON data where it is represented as a JSON object.

    Declaration

    Swift

    let kAOb: OutcomeSymbols

  • A struct of type ControlFlowNodeSymbols mapped to the controlflow_node_type_symbols key in the Formatting JSON data where it is represented as a JSON object.

    Declaration

    Swift

    let kBOb: ControlFlowNodeSymbols

  • A struct of type FunctionTypeSymbols mapped to the function_type_symbols key in the Formatting JSON data where it is represented as a JSON object.

    Declaration

    Swift

    let kCOb: FunctionTypeSymbols

  • A struct of type Spacers mapped to the spacers key in the Formatting JSON data where it is represented as a JSON object.

    Declaration

    Swift

    let kDOb: Spacers

  • A struct embedded inside a FormattingManagerService struct used as a nested layer within a model used to decode Formatting JSON data.

    The struct models the JSON object mapped to the outcome_symbols key in the Formatting JSON data.

    Most of the parameters within the outcome_symbols JSON object relate to the outcome of various conditional statements. The parameters key string values are used to format the outcome symbol of node types when displaying messages in the console.

    Note

    Note The struct uses a custom semantic naming system to name properties associated with key value pairs and their position in the JSON. This system was developed as an aid to correctly map each key to its position in the struct.
    See more

    Declaration

    Swift

    struct OutcomeSymbols : Codable, Equatable

  • A struct embedded inside a FormattingManagerService struct used as a nested layer within a model used to decode Formatting JSON data.

    The struct models the JSON object mapped to the controlflow_node_type_symbols key in the Formatting JSON data.

    The parameters key string values are used to format the control flow node type symbol of node types when displaying messages in the console.

    Note

    Note The struct uses a custom semantic naming system to name properties associated with key value pairs and their position in the JSON. This system was developed as an aid to correctly map each key to its position in the struct.
    See more

    Declaration

    Swift

    struct ControlFlowNodeSymbols : Codable, Equatable

  • A struct embedded inside a FormattingManagerService struct used as a nested layer within a model used to decode Formatting JSON data.

    The struct models the JSON object mapped to the function_type_symbols key in the Formatting JSON data.

    The parameters key string values are used to format the function type symbol of node types when displaying functionName messages in the console.

    Note

    Note 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.

    The struct uses a custom semantic naming system to name properties associated with key value pairs and their position in the JSON. This system was developed as an aid to correctly map each key to its position in the struct.

    See more

    Declaration

    Swift

    struct FunctionTypeSymbols : Codable, Equatable

  • A struct embedded inside a FormattingManagerService struct used as a nested layer within a model used to decode Formatting JSON data.

    The struct models the JSON object mapped to the spacers key in the Formatting JSON data.

    The parameters key integer values are used to add additional custom spacers at specific locations within each message printed to the console. A single integer represents one character of empty space in the console.

    Note

    Note Use of the custom spacers is discretionary and not necessary for formatting print messages.
    See more

    Declaration

    Swift

    struct Spacers : Codable, Equatable

  • An enum that conforms to the CodingKey protocol for storing the key strings used to decode FormattingManagerService from the JSON data.

    See more

    Declaration

    Swift

    enum CodingKeys : String, CodingKey