SignpostConfiguration

public struct SignpostConfiguration

Configuration values for the Publishers.Signpost operator.

Pass Publishers.SignpostConfiguration.Marker values to the initializer to define how signposts for each event should be labelled:

A nil marker value will disable signposts for that event
A .default marker value will use the event name as the event label
A .named(_:) marker value will use the passed string as the event label


                    
                    
                    init(log:receiveSubscriptionMarker:receiveMarker:receiveCompletionMarker:requestMarker:cancelMarker:)

Configuration values for the Publishers.Signpost operator.

The default value specifies signposts should be grouped into the com.github.tcldr.Entwine.Signpost subsystem using the .pointsOfInterest category (displayed in most Xcode Intruments templates by default under the ‘Points of Interest’ instrument).

Use a Publishers.SignpostConfiguration.Marker value to define how signposts for each event should be labelled:

A nil marker value will disable signposts for that event
A .default marker value will use the event name as the event label
A .named(_:) marker value will use the passed string as the event label

Declaration

Swift

public init(
    log: OSLog = OSLog(subsystem: "com.github.tcldr.Entwine.Signpost", category: .pointsOfInterest),
    receiveSubscriptionMarker: Marker? = nil,
    receiveMarker: Marker? = nil,
    receiveCompletionMarker: Marker? = nil,
    requestMarker: Marker? = nil,
    cancelMarker: Marker? = nil
)

Parameters

`log`	The OSLog parameters to be used to mark signposts
`receiveSubscriptionMarker`	A marker value to identify subscription events. A `default` value yields an event labelled `subscription`
`receiveMarker`	A marker value to identify sequence output events. A `default` value yields an event labelled `receive`
`receiveCompletionMarker`	A marker value to identify sequence completion events. A `default` value yields an event labelled `receiveCompletion`
`requestMarker`	A marker value to identify demand request events. A `default` value yields an event labelled `request`
`cancelMarker`	A marker value to identify cancellation events. A `default` value yields an event labelled `cancel`