mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
3c7f6d88e2
types without formatting options, add an auto-inferred privacy mode and make it the default privacy mode, add support for aligning string arguments.
85 lines
2.7 KiB
Swift
85 lines
2.7 KiB
Swift
//===----------------- 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.
|
|
|
|
@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)
|
|
}
|
|
}
|