You're viewing documentation for a pre-release version. View the latest stable version

Structure

ConsoleStyle

Representation of a style for outputting to a Console in different colors with differing attributes. A few suggested default styles are provided.

struct ConsoleStyle

Topics

Initializers

init(color: ConsoleColor?, background: ConsoleColor?, isBold: Bool)
Creates a new ConsoleStyle.

Instance Properties

let background: ConsoleColor?
Optional background color. If nil background is plain.
let color: ConsoleColor?
Optional text color. If nil, text is plain.
let isBold: Bool
If true, text is bold.

Type Properties

static var error: ConsoleStyle
Red text with no background.
static var info: ConsoleStyle
Light blue text with no background.
static var plain: ConsoleStyle
Plain text with no color or background.
static var success: ConsoleStyle
Green text with no background.
static var warning: ConsoleStyle
Yellow text with no background.

Relationships

Conforms To

Swift.Sendable
Swift.SendableMetatype

See Also

Terminal

protocol Console
Protocol for powering styled Console I/O.
class Terminal
Generic console that uses a mixture of Swift and C standard libraries to fulfill protocol requirements.
enum ConsoleColor
Supported colors for creating a ConsoleStyle for ConsoleText.
enum ConsoleClear
Supported methods for clearing the Console.
struct ConsoleText
A collection of ConsoleTextFragments. Represents stylized text that can be outputted to a Console.
struct ConsoleTextFragment
A single piece of ConsoleText. Contains a raw String and the desired ConsoleStyle.
func + (ConsoleText, ConsoleText) -> ConsoleText
Appends a ConsoleText to another ConsoleText.
func += (inout ConsoleText, ConsoleText)
Appends a ConsoleText to another ConsoleText in-place.
extension StringProtocol