Files
swift-mirror/stdlib/private/OSLog/OSLogStringAlignment.swift
Ravi Kandhadai 4f2a55bdd4 [stdlib/private][OSLog] Support expressive, fprintf-style formatting
options for integers passed to os log string interpolation.
2020-02-07 17:36:06 -08:00

70 lines
2.1 KiB
Swift

@frozen
public enum OSLogCollectionBound {
case start
case end
}
@frozen
public struct OSLogStringAlignment {
/// Minimum number of characters to be displayed. If the value to be printed
/// is shorter than this number, the result is padded with spaces. The value
/// is not truncated even if the result is larger.
public var minimumColumnWidth: Int
/// This captures right/left alignment.
public var anchor: OSLogCollectionBound
/// - Parameters:
/// - minimumColumnWidth: Minimum number of characters to be displayed. If the value to be
/// printed is shorter than this number, the result is padded with spaces. The value is not truncated
/// even if the result is larger.
/// - anchor: Use `.end` for right alignment and `.start` for left.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public init(
minimumColumnWidth: Int = 0,
anchor: OSLogCollectionBound = .end
) {
self.minimumColumnWidth = minimumColumnWidth
self.anchor = anchor
}
/// Right alignment formatter.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var right: OSLogStringAlignment {
OSLogStringAlignment(anchor: .end)
}
/// Left alignment formatter.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var left: OSLogStringAlignment {
OSLogStringAlignment(anchor: .start)
}
/// Use default alignment, which is right alignment.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var none: OSLogStringAlignment { .right }
/// Right align and display at least`columns` characters.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func right(columns: Int = 0) -> OSLogStringAlignment {
OSLogStringAlignment(minimumColumnWidth: columns, anchor: .end)
}
/// Left align and display at least`columns` characters.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func left(columns: Int = 0) -> OSLogStringAlignment {
OSLogStringAlignment(minimumColumnWidth: columns, anchor: .start)
}
}