Date.AnchoredRelativeFormatStyle

unitsStyle

get unitsStyle(): Date_RelativeFormatStyle_UnitsStyle

var unitsStyle: Date.AnchoredRelativeFormatStyle.UnitsStyle { get set }

unitsStyle

set unitsStyle(value: Date_RelativeFormatStyle_UnitsStyle)

var unitsStyle: Date.AnchoredRelativeFormatStyle.UnitsStyle { get set }

presentation

get presentation(): Date_RelativeFormatStyle_Presentation

var presentation: Date.AnchoredRelativeFormatStyle.Presentation { get set }

presentation

set presentation(value: Date_RelativeFormatStyle_Presentation)

var presentation: Date.AnchoredRelativeFormatStyle.Presentation { get set }

allowedFields

get allowedFields(): Array<Date_ComponentsFormatStyle_Field>

var allowedFields: Set<Date.AnchoredRelativeFormatStyle.Field> { get set }

The fields that can be used in the formatted output.

allowedFields

set allowedFields(value: Array<Date_ComponentsFormatStyle_Field>)

var allowedFields: Set<Date.AnchoredRelativeFormatStyle.Field> { get set }

The fields that can be used in the formatted output.

discreteInput

discreteInputAfter(input: globalThis.Date): (globalThis.Date) | null

func discreteInput(after input: Date) -> Date?

The next discretization boundary after the given input. Use this function to determine the next "greater" input that warrants updating the formatted output. The following example prints all possible outputs the format style can produce upwards starting from the `startInput`: ```swift var previousInput = startInput while let nextInput = style.discreteInput(after: previousInput) { print(style.format(nextInput)) previousInput = nextInput } ``` - Returns: For most `input`s, the method returns the "smallest" value "greater" than `input` for which the style produces a different ``FormatStyle/FormatOutput``, or `nil` if no such value exists. For some input values, the function may also return a value "greater" than `input` for which the style still produces the same ``FormatStyle/FormatOutput`` as for `input`.

discreteInput

discreteInputBefore(input: globalThis.Date): (globalThis.Date) | null

func discreteInput(before input: Date) -> Date?

The next discretization boundary before the given input. Use this function to determine the next "smaller" input that warrants updating the formatted output. The following example prints all possible outputs the format style can produce downwards starting from the `startInput`: ```swift var previousInput = startInput while let nextInput = style.discreteInput(before: previousInput) { print(style.format(nextInput)) previousInput = nextInput } ``` - Returns: For most `input`s, the method returns the "greatest" value "smaller" than `input` for which the style produces a different ``FormatStyle/FormatOutput``, or `nil` if no such value exists. For some input values, the function may also return a value "smaller" than `input` for which the style still produces the same ``FormatStyle/FormatOutput`` as for `input`.

capitalizationContext

get capitalizationContext(): FormatStyleCapitalizationContext

var capitalizationContext: FormatStyleCapitalizationContext { get set }

capitalizationContext

set capitalizationContext(value: FormatStyleCapitalizationContext)

var capitalizationContext: FormatStyleCapitalizationContext { get set }

input

inputAfter(input: globalThis.Date): (globalThis.Date) | null

func input(after input: Date) -> Date?

The next input value after the given input. Use this function to determine if the return value provided by ``discreteInput(before:)`` is precise enough for your use case for any input `y`: ```swift guard let x = style.discreteInput(before: y) else { return } let z = style.input(after: x) ?? y ``` If the distance between `x` and `z` is too large for the precision you require, you may want to manually probe ``FormatStyle/format(_:)`` at a higher rate in that interval, as there is no guarantee for what the output will be in that interval. - Returns: The next "greater" input value that can be represented by ``FormatStyle/FormatInput`` or an underlying representation the format style uses internally.

input

inputBefore(input: globalThis.Date): (globalThis.Date) | null

func input(before input: Date) -> Date?

The next input value before the given input. Use this function to determine if the return value provided by ``discreteInput(after:)`` is precise enough for your use case for any input `y`: ```swift guard let x = style.discreteInput(after: y) else { return } let z = style.input(before: x) ?? y ``` If the distance between `z` and `x` is too large for the precision you require, you may want to manually probe ``FormatStyle/format(_:)`` at a higher rate in that interval, as there is no guarantee for what the output will be in that interval. - Returns: The next "smalller" input value that can be represented by ``FormatStyle/FormatInput`` or an underlying representation the format style uses internally.

init

static initAnchorPresentationUnitsStyleLocaleCalendarCapitalizationContext(anchor: globalThis.Date, presentation?: Date_RelativeFormatStyle_Presentation, unitsStyle?: Date_RelativeFormatStyle_UnitsStyle, locale?: Locale, calendar?: Calendar, capitalizationContext?: FormatStyleCapitalizationContext): Date_AnchoredRelativeFormatStyle

init(anchor: Date, presentation: Date.AnchoredRelativeFormatStyle.Presentation = .numeric, unitsStyle: Date.AnchoredRelativeFormatStyle.UnitsStyle = .wide, locale: Locale = .autoupdatingCurrent, calendar: Calendar = .autoupdatingCurrent, capitalizationContext: FormatStyleCapitalizationContext = .unknown)

Create a relative format style that is detached from the system time, and instead formats an anchor date relative to the format input. - Parameter anchor: The date the formatted output is referring to.

init

static initAnchorAllowedFieldsPresentationUnitsStyleLocaleCalendarCapitalizationContext(anchor: globalThis.Date, allowedFields: Array<Date_ComponentsFormatStyle_Field>, presentation?: Date_RelativeFormatStyle_Presentation, unitsStyle?: Date_RelativeFormatStyle_UnitsStyle, locale?: Locale, calendar?: Calendar, capitalizationContext?: FormatStyleCapitalizationContext): Date_AnchoredRelativeFormatStyle

init(anchor: Date, allowedFields: Set<Date.AnchoredRelativeFormatStyle.Field>, presentation: Date.AnchoredRelativeFormatStyle.Presentation = .numeric, unitsStyle: Date.AnchoredRelativeFormatStyle.UnitsStyle = .wide, locale: Locale = .autoupdatingCurrent, calendar: Calendar = .autoupdatingCurrent, capitalizationContext: FormatStyleCapitalizationContext = .unknown)

Create a relative format style that is detached from the system time, and instead formats an anchor date relative to the format input. - Parameter anchor: The date the formatted output is referring to.

anchor

get anchor(): globalThis.Date

var anchor: Date

The date the formatted output refers to from the perspective of the input values.

anchor

set anchor(value: globalThis.Date)

var anchor: Date

The date the formatted output refers to from the perspective of the input values.

format

format(input: globalThis.Date): string

func format(_ input: Date) -> String

Formats a value, using this style. Use this method when you want to create a single style instance, and then use it to format multiple values. - Parameter value: The value to format. - Returns: A representation of `value`, in the ``FormatOutput`` type, formatted according to the style's configuration.

locale

get locale(): Locale

var locale: Locale { get set }

locale

set locale(value: Locale)

var locale: Locale { get set }

locale

locale88239(locale: Locale): Date_AnchoredRelativeFormatStyle

func locale(_ locale: Locale) -> Date.AnchoredRelativeFormatStyle

Modifies the format style to use the specified locale. Use this format style to change the locale used by an existing format style. - Parameter locale: The locale to apply to the format style. - Returns: A format style modified to use the provided locale.

calendar

get calendar(): Calendar

var calendar: Calendar { get set }

calendar

set calendar(value: Calendar)

var calendar: Calendar { get set }