Scroll to navigation

BSON::Int32(3pm) User Contributed Perl Documentation BSON::Int32(3pm)

NAME

BSON::Int32 - BSON type wrapper for Int32

VERSION

version v1.12.2

SYNOPSIS

    use BSON::Types ':all';
    bson_int32( $number );

DESCRIPTION

This module provides a BSON type wrapper for a numeric value that would be represented in BSON as a 32-bit integer.

If the value won't fit in a 32-bit integer, an error will be thrown.

ATTRIBUTES

value

A numeric scalar. It will be coerced to an integer. The default is 0.

METHODS

TO_JSON

Returns the value as an integer.

If the "BSON_EXTJSON" environment variable is true and the "BSON_EXTJSON_RELAXED" environment variable is false, returns a hashref compatible with MongoDB's extended JSON <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst> format, which represents it as a document as follows:

    {"$numberInt" : "42"}

OVERLOADING

The numification operator, "0+" is overloaded to return the "value", the full "minimal set" of overloaded operations is provided (per overload documentation) and fallback overloading is enabled.

AUTHORS

  • David Golden <david@mongodb.com>
  • Stefan G. <minimalist@lavabit.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Stefan G. and MongoDB, Inc.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2020-08-14 perl v5.30.3