Declaration
Declaration
Swift
-public class HeliumStreamLogger<OutputStream: TextOutputStream> : HeliumLoggerpublic class HeliumStreamLogger<OutputStream> : HeliumLogger where OutputStream : TextOutputStreamSwift
-public class HeliumStreamLogger<OutputStream: TextOutputStream> : HeliumLoggerpublic class HeliumStreamLogger<OutputStream> : HeliumLogger where OutputStream : TextOutputStreamSwift
-public var colored: Bool = falsepublic var colored: BoolSwift
-public var details: Bool = truepublic var details: Bool
+
+
+ includeMetadata
+
+ A Boolean value indicating whether to include SwiftLog metadata in the logging format when a user +logging format is not specified.
+ +Swift
+public var includeMetadata: Bool
+
+
+ includeLabel
+
+ A Boolean value indicating whether to include SwiftLog label in the logging format when a user +logging format is not specified.
+ +Swift
+public var includeLabel: Bool
-
+
- fullFilePath
+ fullFilePath
Swift
-public var fullFilePath: Bool = falsepublic var fullFilePath: BoolThe user specified logging format, if format is not nil.
For example: [(%date)] [(%type)] [(%file):(%line) (%func)] (%msg)
.
For example: [(%date)] [(%label)] [(%type)] [(%file):(%line) (%func)] (%msg)
.
Swift
-public var format: String?public var format: String? { get set }
-
+
- dateFormat
+ dateFormat
Swift
-public var dateFormat: String?public var dateFormat: String? { get set }Swift
-public var timeZone: TimeZone?public var timeZone: TimeZone? { get set }
-
+
- defaultDateFormat
+ defaultDateFormat
Swift
-public static let defaultDateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ"public static let defaultDateFormat: String
-
+
+
+ bootstrapSwiftLog(_:)
+
+ A one-time configuration function to bootstrap the SwiftLog logging system
+ using HeliumLogger as the logging backend.
This bootstraps the SwiftLog logging system with a default
+ HeliumLogger instance. The default HeliumLogger instance will
+ be used as the logging backend for SwiftLog.
HeliumLogger.bootstrapSwiftLog()
+It’s also possible to customize the default HeliumLogger instance using a configuration closure.
HeliumLogger.bootstrapSwiftLog { heliumLogger in
+ heliumLogger.colored = true
+}
+Swift
+public static func bootstrapSwiftLog(_ configure: ((HeliumLogger) -> Void)? = nil)
+
+ configure
+
+ |
+
+
+
+ An optional closure that may be used to configure the default |
+
+
+
+ makeLogHandler(label:)
+
+ Creates a HeliumLogHandler instance for use with the SwiftLog logging system.
This may be used to bootstrap the SwiftLog logging system with a
+ HeliumLogger instance. The HeliumLogger instance will
+ be used as the logging backend for SwiftLog.
let heliumLogger = HeliumLogger()
+LoggingSystem.bootstrap(heliumLogger.makeLogHandler)
+Swift
+public func makeLogHandler(label: String) -> HeliumLogHandler
+
+ label
+
+ |
+
+
+
+ The label to use for a SwiftLog |
+
+
+
+ makeLogHandler(label:)
+
+ Creates a HeliumLogHandler instance for use with the SwiftLog logging system.
This may be used to bootstrap the SwiftLog logging system with a default
+ HeliumLogger instance. The default HeliumLogger instance will
+ be used as the logging backend for SwiftLog.
LoggingSystem.bootstrap(HeliumLogger.makeLogHandler)
+Swift
+public static func makeLogHandler(label: String) -> HeliumLogHandler
+
+ label
+
+ |
+
+
+
+ The label to use for a SwiftLog |
+
-
+
- isLogging(_:)
+ isLogging(_:)