MongoDB Inc > BSON > BSON::String

Download:
BSON-0.12.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.12   Source   Latest Release: BSON-0.15-TRIAL

NAME ^

BSON::String - String data for BSON

VERSION ^

version 0.12

SYNOPSIS ^

    use BSON 'encode';

    my $str1 = BSON::String->new('Jack Reacher');
    my $str2 = BSON::String->new('55');
    my $str3 = BSON::String->new('-1234.7654');

    my $bson = encode( { a => $str1, b => $str2, c => $str3 } );

DESCRIPTION ^

Since Perl does not distinguish between numbers and strings, this module is provides an explicit string type for BSON's string element. It's very simple and does not implement any operator overloading other than "".

METHODS ^

new

Main constructor which takes a single parameter - the string.

    my $string = BSON::String->new('Hello, there!');
    print "$string\n";    # Prints 'Hello, there!'
    if ( "$string" gt "abcde" ) {

        # This will work
        ...;
    }

value

Returns the value of the string.

OVERLOAD ^

Only the "" operator is overloaded. You won't be able to perform string comparison on a BSON::String instance.

SEE ALSO ^

BSON

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2015 by minimalist and MongoDB, Inc..

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
syntax highlighting: