StructureSwift

Duration.UnitsFormatStyle

iOS 16.0+ iPadOS 16.0+ Mac Catalyst 16.0+ macOS 13.0+ tvOS 16.0+ watchOS 9.0+

A FormatStyle that displays a duration as a list of duration units, such as “2 hours, 43 minutes, 26 seconds” in English.

struct UnitsFormatStyle

Topics

struct Attributed
A format style to format a duration as an attributed string. Units in the string are annotated with the durationField and measurement attribute keys and the DurationFieldAttribute and MeasurementAttribute attribute values.
struct FractionalPartDisplayStrategy
Specifies how a duration is displayed if it cannot be represented exactly with the allowed units.
struct Unit
Units that a duration can be displayed as with UnitsFormatStyle.
struct UnitWidth
Specifies the width of the unit and the spacing of the value and the unit.
struct ZeroValueUnitsDisplayStrategy
Specifies how zero value units are handled.

var allowedUnits: Set<Duration.UnitsFormatStyle.Unit>
The units that may be included in the output string.
var attributed: Duration.UnitsFormatStyle.Attributed
Returns a Duration.UnitsFormatStyle.Attributed style to format a duration as an attributed string using the configuration of this format style. Units in the string are annotated with the durationField and measurement attribute keys and the DurationFieldAttribute and MeasurementAttribute attribute values.
var fractionalPartDisplay: Duration.UnitsFormatStyle.FractionalPartDisplayStrategy
The strategy for displaying a duration if it cannot be represented exactly with the allowed units.
var locale: Locale
The locale to use when formatting the duration.
var maximumUnitCount: Int?
The maximum number of time units to include in the output string.
var unitWidth: Duration.UnitsFormatStyle.UnitWidth
The width of the unit and the spacing between the value and the unit.
var valueLengthLimits: Range<Int>?
The padding or truncating behavior of the unit value.
var zeroValueUnitsDisplay: Duration.UnitsFormatStyle.ZeroValueUnitsDisplayStrategy
The strategy for how zero-value units are handled.

func format(Duration) -> String
Creates a locale-aware string representation from a duration value.
func locale(Locale) -> Duration.UnitsFormatStyle
A modifier to set the locale of the format style.