—

              
#
#  Copyright 2014 MongoDB, Inc.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#  http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
#
package MongoDB::CommandResult;
# ABSTRACT: MongoDB generic command result document
use version;
our $VERSION = 'v0.999.999.1'; # TRIAL
use Moose;
use MongoDB::Error;
use MongoDB::_Types -types;
use Types::Standard -types;
use namespace::clean -except => 'meta';
with 'MongoDB::Role::_LastError';
#pod =attr output
#pod
#pod Hash reference with the output document of a database command
#pod
#pod =cut
has output => (
    is       => 'ro',
    isa      => HashRef,
    required => 1,
);
#pod =attr address
#pod
#pod Address ("host:port") of server that ran the command
#pod
#pod =cut
has address => (
    is       => 'ro',
    isa      => HostAddress,
    required => 1,
);
#pod =method last_code
#pod
#pod Error code (if any) or 0 if there was no error.
#pod
#pod =cut
sub last_code {
    my ($self) = @_;
    my $output = $self->output;
    if ( $output->{code} ) {
        return $output->{code};
    }
    elsif ( $output->{lastErrorObject} ) {
        return $output->{lastErrorObject}{code} || 0;
    }
    else {
        return 0;
    }
}
#pod =method last_errmsg
#pod
#pod Error string (if any) or the empty string if there was no error.
#pod
#pod =cut
sub last_errmsg {
    my ($self) = @_;
    for my $err_key (qw/$err err errmsg/) {
        return $self->output->{$err_key} if exists $self->output->{$err_key};
    }
    return "";
}
#pod =method last_wtimeout
#pod
#pod True if a write concern timed out or false otherwise.
#pod
#pod =cut
sub last_wtimeout {
    my ($self) = @_;
    return !!$self->output->{wtimeout};
}
#pod =method assert
#pod
#pod Throws an exception if the command failed.
#pod
#pod =cut
sub assert {
    my ($self, $default_class) = @_;
    $self->_throw_database_error( $default_class )
        if ! $self->output->{ok};
    return 1;
}
# deprecated
sub result { shift->output }
__PACKAGE__->meta->make_immutable;
1;
__END__
HideShow 92 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
MongoDB::CommandResult - MongoDB generic command result document
=head1 VERSION
version v0.999.999.1
=head1 DESCRIPTION
This class encapsulates the results from a database command.  Currently, it is
only available from the C<result> attribute of C<MongoDB::DatabaseError>.
=head1 ATTRIBUTES
=head2 output
Hash reference with the output document of a database command
=head2 address
Address ("host:port") of server that ran the command
=head1 METHODS
=head2 last_code
Error code (if any) or 0 if there was no error.
=head2 last_errmsg
Error string (if any) or the empty string if there was no error.
=head2 last_wtimeout
True if a write concern timed out or false otherwise.
=head2 assert
Throws an exception if the command failed.
=for Pod::Coverage result
=head1 DEPRECATIONS
The methods still exist, but are no longer documented.  In a future version
they will warn when used, then will eventually be removed.
=over 4
=item *
result
=back
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Mike Friedman <friedo@friedo.com>
=item *
Kristina Chodorow <k.chodorow@gmail.com>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2015 by MongoDB, Inc..
This is free software, licensed under:
  The Apache License, Version 2.0, January 2004
=cut