bson_extract.h

/*    Copyright 2012 10gen 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.
 */

#pragma once

#include <string>
#include <vector>

#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsontypes.h"

namespace mongo {

class BSONObj;
class BSONElement;
class OID;

Status bsonExtractField(const BSONObj& object,
                        const StringData& fieldName,
                        BSONElement* outElement);

Status bsonExtractTypedField(const BSONObj& object,
                             const StringData& fieldName,
                             BSONType type,
                             BSONElement* outElement);

Status bsonExtractBooleanField(const BSONObj& object, const StringData& fieldName, bool* out);

Status bsonExtractIntegerField(const BSONObj& object, const StringData& fieldName, long long* out);

Status bsonExtractStringField(const BSONObj& object, const StringData& fieldName, std::string* out);

Status bsonExtractOIDField(const BSONObj& object, const StringData& fieldName, OID* out);

Status bsonExtractBooleanFieldWithDefault(const BSONObj& object,
                                          const StringData& fieldName,
                                          bool defaultValue,
                                          bool* out);

Status bsonExtractIntegerFieldWithDefault(const BSONObj& object,
                                          const StringData& fieldName,
                                          long long defaultValue,
                                          long long* out);

Status bsonExtractStringFieldWithDefault(const BSONObj& object,
                                         const StringData& fieldName,
                                         const StringData& defaultValue,
                                         std::string* out);

Status bsonExtractOIDFieldWithDefault(const BSONObj& object,
                                      const StringData& fieldName,
                                      const OID& defaultValue,
                                      OID* out);

}  // namespace mongo