Menu
Search

API Documentation

version 2.108.0

overview

View source code
Display the source code in core/time.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
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.

Function core.time.Duration.total

Returns the total number of the given units in this Duration. So, unlike split, it does not strip out the larger units.

long total(string units)() const nothrow @nogc @property
if (units == "weeks" || units == "days" || units == "hours" || units == "minutes" || units == "seconds" || units == "msecs" || units == "usecs" || units == "hnsecs" || units == "nsecs");

Example

writeln(dur!"weeks"(12).total!"weeks"); // 12
writeln(dur!"weeks"(12).total!"days"); // 84

writeln(dur!"days"(13).total!"weeks"); // 1
writeln(dur!"days"(13).total!"days"); // 13

writeln(dur!"hours"(49).total!"days"); // 2
writeln(dur!"hours"(49).total!"hours"); // 49

writeln(dur!"nsecs"(2007).total!"hnsecs"); // 20
writeln(dur!"nsecs"(2007).total!"nsecs"); // 2000

Example

writeln(Duration.zero.toString()); // "0 hnsecs"
writeln(weeks(5).toString()); // "5 weeks"
writeln(days(2).toString()); // "2 days"
writeln(hours(1).toString()); // "1 hour"
writeln(minutes(19).toString()); // "19 minutes"
writeln(seconds(42).toString()); // "42 secs"
writeln(msecs(42).toString()); // "42 ms"
writeln(usecs(27).toString()); // "27 μs"
writeln(hnsecs(5).toString()); // "5 hnsecs"

writeln(seconds(121).toString()); // "2 minutes and 1 sec"
assert((minutes(5) + seconds(3) + usecs(4)).toString() ==
       "5 minutes, 3 secs, and 4 μs");

writeln(seconds(-42).toString()); // "-42 secs"
writeln(usecs(-5239492).toString()); // "-5 secs, -239 ms, and -492 μs"

Authors

Jonathan M Davis and Kato Shoichi

License

Boost License 1.0.