ProgressReport

 
public protocol ProgressReport

Notifies the progress of an event.

  • Notifies the status of an event.

    Declaration

    Swift

    func notify<E, A>(_ event: ProgressEvent<A>) -> IO<E, Void> where E : Error, A : CustomProgressDescription

    Parameters

    event

    Progress description.

    Return Value

    An IO describing the progress report.

  • oneShot(_:) Extension method

    Reports an event that completes successfully and instantly.

    Declaration

    Swift

    func oneShot<E, A>(_ step: A) -> IO<E, Void> where E : Error, A : CustomProgressDescription

    Parameters

    step

    Step description.

    Return Value

    An IO describing the progress report.

  • inProgress(_:) Extension method

    Reports an ongoing event.

    Declaration

    Swift

    func inProgress<E, A>(_ step: A) -> IO<E, Void> where E : Error, A : CustomProgressDescription

    Parameters

    step

    Step description.

    Return Value

    An IO describing the progress report.

  • succeeded(_:) Extension method

    Reports the successful completion of an event.

    Declaration

    Swift

    func succeeded<E, A>(_ step: A) -> IO<E, Void> where E : Error, A : CustomProgressDescription

    Parameters

    step

    Step description.

    Return Value

    An IO describing the progress report.

  • failed(_:) Extension method

    Reports the failed completion of an event.

    Declaration

    Swift

    func failed<E, A>(_ step: A) -> IO<E, Void> where E : Error, A : CustomProgressDescription

    Parameters

    step

    Step description.

    Return Value

    An IO describing the progress report.