Display the source code in core/time.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Template `core.time.Duration.split`

Splits out the Duration into the given units.


						
				template split(units...)
				;

split takes the list of time units to split out as template arguments. The time unit strings must be given in decreasing order. How it returns the values for those units depends on the overload used.

The overload which accepts function arguments takes integral types in the order that the time unit strings were given, and those integers are passed by ref. split assigns the values for the units to each corresponding integer. Any integral type may be used, but no attempt is made to prevent integer overflow, so don't use small integral types in circumstances where the values for those units aren't likely to fit in an integral type that small.

The overload with no arguments returns the values for the units in a struct with members whose names are the same as the given time unit strings. The members are all longs. This overload will also work with no time strings being given, in which case all of the time units from weeks through hnsecs will be provided (but no nsecs, since it would always be 0).

For both overloads, the entire value of the Duration is split among the units (rather than splitting the Duration across all units and then only providing the values for the requested units), so if only one unit is given, the result is equivalent to total.

"nsecs" is accepted by split, but "years" and "months" are not.

For negative durations, all of the split values will be negative.

Contained Functions

Name	Description
split

Example

{
    auto d = dur!"days"(12) + dur!"minutes"(7) + dur!"usecs"(501223);
    long days;
    int seconds;
    short msecs;
    d.split!("days", "seconds", "msecs")(days, seconds, msecs);
    writeln(days); // 12
    writeln(seconds); // 7 * 60
    writeln(msecs); // 501

    auto splitStruct = d.split!("days", "seconds", "msecs")();
    writeln(splitStruct.days); // 12
    writeln(splitStruct.seconds); // 7 * 60
    writeln(splitStruct.msecs); // 501

    auto fullSplitStruct = d.split();
    writeln(fullSplitStruct.weeks); // 1
    writeln(fullSplitStruct.days); // 5
    writeln(fullSplitStruct.hours); // 0
    writeln(fullSplitStruct.minutes); // 7
    writeln(fullSplitStruct.seconds); // 0
    writeln(fullSplitStruct.msecs); // 501
    writeln(fullSplitStruct.usecs); // 223
    writeln(fullSplitStruct.hnsecs); // 0

    writeln(d.split!"minutes"().minutes); // d.total!"minutes"
}

{
    auto d = dur!"days"(12);
    writeln(d.split!"weeks"().weeks); // 1
    writeln(d.split!"days"().days); // 12

    writeln(d.split().weeks); // 1
    writeln(d.split().days); // 5
}

{
    auto d = dur!"days"(7) + dur!"hnsecs"(42);
    writeln(d.split!("seconds", "nsecs")().nsecs); // 4200
}

{
    auto d = dur!"days"(-7) + dur!"hours"(-9);
    auto result = d.split!("days", "hours")();
    writeln(result.days); // -7
    writeln(result.hours); // -9
}

Authors

Jonathan M Davis and Kato Shoichi

License

Boost License 1.0.