1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
|
//===----------------- OSLogStringAlignment.swift -------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
// This file defines types and functions for specifying alignment of the
// interpolations passed to the os log APIs.
@usableFromInline
internal 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. This value need not be a
/// compile-time constant, and is therefore an autoclosure.
@usableFromInline
internal var minimumColumnWidth: (() -> Int)?
/// This captures right/left alignment.
@usableFromInline
internal var anchor: OSLogCollectionBound
/// Initializes stored properties.
///
/// - 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.
@_transparent
@usableFromInline
internal init(
minimumColumnWidth: (() -> Int)? = nil,
anchor: OSLogCollectionBound = .end
) {
self.minimumColumnWidth = minimumColumnWidth
self.anchor = anchor
}
/// Indicates no alignment.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static var none: OSLogStringAlignment { OSLogStringAlignment(anchor: .end) }
/// Right align and display at least `columns` characters.
///
/// The interpolated value would be padded with spaces, if necessary, to
/// meet the specified `columns` characters.
///
/// - Parameter columns: minimum number of characters to display.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func right(
columns: @escaping @autoclosure () -> Int
) -> OSLogStringAlignment {
OSLogStringAlignment(minimumColumnWidth: columns, anchor: .end)
}
/// Left align and display at least `columns` characters.
///
/// The interpolated value would be padded with spaces, if necessary, to
/// meet the specified `columns` characters.
///
/// - Parameter columns: minimum number of characters to display.
@_semantics("constant_evaluable")
@inlinable
@_optimize(none)
public static func left(
columns: @escaping @autoclosure () -> Int
) -> OSLogStringAlignment {
OSLogStringAlignment(minimumColumnWidth: columns, anchor: .start)
}
}
|