You're viewing documentation for a pre-release version. View the latest stable version

Protocol

ActivityIndicatorType

ActivityIndicatorTypes are responsible for drawing / rendering the current ActivityIndicatorState to the Console.

protocol ActivityIndicatorType : Sendable

Overview

ActivityIndicators are created from an instance of ActivityIndicatorType and control the implementation behind calling the ActivityIndicatorType for ActivityIndicatorState changes.

See the ActivityBar protocol which is based off of this protocol.

Topics

Instance Methods

func newActivity(for: any Console) -> ActivityIndicator<Self>
Creates a new ActivityIndicator for this ActivityIndicatorType.
func outputActivityIndicator(to: any Console, state: ActivityIndicatorState)
Draws / renders this ActivityIndicatorType to the Console for the supplied ActivityIndicatorState.

Relationships

Inherits From

Swift.Sendable
Swift.SendableMetatype

Inherited By

ActivityBar

Conforming Types

See Also

Activity

class ActivityIndicator
An instance of a ActivityIndicatorType that can be started, failed, and succeeded.
enum ActivityIndicatorState
Possible states to draw / render and ActivityIndicatorType.
protocol ActivityBar
An ActivityIndicatorType that renders an activity bar on a single line.
struct LoadingBar
Loading-style implementation of ActivityBar.
struct ProgressBar
Progress-style implementation of ActivityBar.
struct CustomActivity
An activity indicator with customizable frames and success and failure messages.