Duration

Undocumented

  • Convert duration to seconds in string form.

    Declaration

    Swift

    var to_s: String
    Show on GitHub

  • Convert duration to seconds.

    1.year.to_i     #=> 31556952 (length of a gregorian year 365.2425 days)
1.month.to_i    #=> 2629746 ( 1/12 of a gregorian year)
1.week.to_i     #=> 604800
1.day.to_i      #=> 86400
1.hour.to_i     #=> 3600
1.minute.to_i   #=> 60
1.second.to_i   #=> 1

    Declaration

    Swift

    var to_i: Int
    Show on GitHub

  • Undocumented

    Show on GitHub

  • Convert current struct to a DateComponents object, all the components of duration will be assigned to DateComponents object.

    Declaration

    Swift

    func to_dateComponents(before: Bool = false) -> DateComponents

    Parameters

    before

    A bool value indicates the sign of date components

    Return Value

    A DateComponents object containing all the date info

    Show on GitHub

  • Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.

    This function is the only requirement of the Comparable protocol. The remainder of the relational operator functions are implemented by the standard library for any type that conforms to Comparable.

    Declaration

    Swift

    public static func <(lhs: Duration, rhs: Duration) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.
    Show on GitHub

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    public static func ==(lhs: Duration, rhs: Duration) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.
    Show on GitHub

  • Returns a new Duration with the sum of the two Duration

    1.year + 1.year                 #=> 2.years
2.years + 3.years               #=> 5.years
2.years + 1.year + 1.month      #=> 3.years + 1.month

    Declaration

    Swift

    static func +(lhs: Duration, rhs: Duration) -> Duration

    Parameters

    lhs

    A duration
    rhs

    Another duration

    Return Value

    A new duration

    Show on GitHub

  • Returns a new Duration with the subtraction from the left hand side Duration with the right hand side.

    1.year - 1.year                 #=> 0.year
2.year - 1.year                 #=> 1.year
2.years - 3.years               #=> (-1).year
2.years - 1.year - 1.month      #=> 1.year - 1.month

    Declaration

    Swift

    static func -(lhs: Duration, rhs: Duration) -> Duration

    Parameters

    lhs

    A duration
    rhs

    Another duration

    Return Value

    A new duration

    Show on GitHub

  • Retrieve the years component from duration instance.

    Declaration

    Swift

    var years: Int
    Show on GitHub

  • Retrieve the months component from duration instance.

    Declaration

    Swift

    var months: Int
    Show on GitHub

  • Retrieve the weeks component from duration instance.

    Declaration

    Swift

    var weeks: Int
    Show on GitHub

  • Retrieve the days component from duration instance.

    Declaration

    Swift

    var days: Int
    Show on GitHub

  • Retrieve the hours component from duration instance.

    Declaration

    Swift

    var hours: Int
    Show on GitHub

  • Retrieve the minutes component from duration instance.

    Declaration

    Swift

    var minutes: Int
    Show on GitHub

  • Retrieve the seconds component from duration instance.

    Declaration

    Swift

    var seconds: Int
    Show on GitHub