Instance Method

dateIntervalOfWeekend(containing:)

Returns a DateInterval of the weekend contained by the given date, or nil if the date is not in a weekend.

Declaration

func dateIntervalOfWeekend(containing date: Date) -> DateInterval?

Parameters

date

The date contained in the weekend.

Return Value

A DateInterval, or nil if the date is not in a weekend.

See Also

Calculating Intervals

func dateInterval(of: Calendar.Component, for: Date) -> DateInterval?

Returns the starting time and duration of a given calendar component that contains a given date.

func dateInterval(of: Calendar.Component, start: inout Date, interval: inout TimeInterval, for: Date) -> Bool

Returns, via two inout parameters, the starting time and duration of a given calendar component that contains a given date.

func dateIntervalOfWeekend(containing: Date, start: inout Date, interval: inout TimeInterval) -> Bool

Find the range of the weekend around the given date, returned via two by-reference parameters.

func nextWeekend(startingAfter: Date, direction: Calendar.SearchDirection) -> DateInterval?

Returns a DateInterval of the next weekend, which starts strictly after the given date.

func nextWeekend(startingAfter: Date, start: inout Date, interval: inout TimeInterval, direction: Calendar.SearchDirection) -> Bool

Returns the range of the next weekend via two inout parameters. The weekend starts strictly after the given date.

enum Calendar.SearchDirection

The direction in time to search.