Back to Rxswift

Event

docs/Enums/Event.html

6.10.21.9 KB
Original Source

Event

@frozen
public enum Event<Element>
extension Event: CustomDebugStringConvertible
extension Event: EventConvertible

Represents a sequence event.

Sequence grammar: next* (error | completed)

`

                next(_:)
                `

Next element is produced.

Declaration

Swift

case next(Element)

`

                error(_:)
                `

Sequence terminated with an error.

Declaration

Swift

case error(Swift.Error)

`

                completed
                `

Sequence completed successfully.

Declaration

Swift

case completed

`

                debugDescription
                `

Description of event.

Declaration

Swift

public var debugDescription: String { get }

`

                isStopEvent
                `

Is completed or error event.

Declaration

Swift

var isStopEvent: Bool { get }

`

                element
                `

If next event, returns element value.

Declaration

Swift

var element: Element? { get }

`

                error
                `

If error event, returns error.

Declaration

Swift

var error: Swift.Error? { get }

`

                isCompleted
                `

If completed event, returns true.

Declaration

Swift

var isCompleted: Bool { get }

`

                map(_:)
                `

Maps sequence elements using transform. If error happens during the transform, .error will be returned as value.

Declaration

Swift

func map<Result>(_ transform: (Element) throws -> Result) -> Event<Result>

`

                event
                `

Event representation of this instance

Declaration

Swift

public var event: Event<Element> { get }