.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BSON::Time 3pm"
.TH BSON::Time 3pm "2018-12-09" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
BSON::Time \- BSON type wrapper for date and time
.SH "VERSION"
.IX Header "VERSION"
version v1.10.2
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use BSON::Types \*(Aq:all\*(Aq;
\&
\&    bson_time();        # now
\&    bson_time( $secs ); # floating point seconds since epoch
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a \s-1BSON\s0 type wrapper for a 64\-bit date-time value in
the form of milliseconds since the Unix epoch (\s-1UTC\s0 only).
.PP
On a Perl without 64\-bit integer support, the value must be a
Math::BigInt object.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "value"
.IX Subsection "value"
A integer representing milliseconds since the Unix epoch.  The default
is 0.
.SH "METHODS"
.IX Header "METHODS"
.SS "epoch"
.IX Subsection "epoch"
Returns the number of seconds since the epoch (i.e. a floating-point value).
.SS "as_iso8601"
.IX Subsection "as_iso8601"
Returns the \f(CW\*(C`value\*(C'\fR as an \s-1ISO\-8601\s0 formatted string of the form
\&\f(CW\*(C`YYYY\-MM\-DDThh:mm:ss.sssZ\*(C'\fR.  The fractional seconds will be omitted if
they are zero.
.SS "as_datetime"
.IX Subsection "as_datetime"
Loads DateTime and returns the \f(CW\*(C`value\*(C'\fR as a DateTime object.
.SS "as_datetime_tiny"
.IX Subsection "as_datetime_tiny"
Loads DateTime::Tiny and returns the \f(CW\*(C`value\*(C'\fR as a DateTime::Tiny
object.
.SS "as_mango_time"
.IX Subsection "as_mango_time"
Loads Mango::BSON::Time and returns the \f(CW\*(C`value\*(C'\fR as a Mango::BSON::Time
object.
.SS "as_time_moment"
.IX Subsection "as_time_moment"
Loads Time::Moment and returns the \f(CW\*(C`value\*(C'\fR as a Time::Moment object.
.SS "\s-1TO_JSON\s0"
.IX Subsection "TO_JSON"
Returns a string formatted by \*(L"as_iso8601\*(R".
.PP
If the \f(CW\*(C`BSON_EXTJSON\*(C'\fR option is true, it will instead be compatible with
MongoDB's extended \s-1JSON\s0 <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst>
format, which represents it as a document as follows:
.PP
If the \f(CW\*(C`BSON_EXTJSON\*(C'\fR environment variable is true and the
\&\f(CW\*(C`BSON_EXTJSON_RELAXED\*(C'\fR environment variable is false, returns a hashref
compatible with
MongoDB's extended \s-1JSON\s0 <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst>
format, which represents it as a document as follows:
.PP
.Vb 1
\&    {"$date" : { "$numberLong": "22337203685477580" } }
.Ve
.PP
If the \f(CW\*(C`BSON_EXTJSON\*(C'\fR and \f(CW\*(C`BSON_EXTJSON_RELAXED\*(C'\fR environment variables are
both true, then it will return a hashref with an \s-1ISO\-8601\s0 string for dates
after the Unix epoch and before the year 10,000 and a \f(CW$numberLong\fR style
value otherwise.
.PP
.Vb 2
\&    {"$date" : "2012\-12\-24T12:15:30.500Z"}
\&    {"$date" : { "$numberLong": "\-10000000" } }
.Ve
.SH "OVERLOADING"
.IX Header "OVERLOADING"
Both numification (\f(CW\*(C`0+\*(C'\fR) and stringification (\f(CW""\fR) are overloaded to
return the result of \*(L"epoch\*(R".  Numeric comparison and string comparison
are overloaded based on those and fallback overloading is enabled.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <david@mongodb.com>
.IP "\(bu" 4
Stefan G. <minimalist@lavabit.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2018 by Stefan G. and MongoDB, Inc.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve