Sha256: a9e74901bdbf022986256b9f22083456f3d6d16a2d3a9a6eaad691a93549267b

Contents?: true

Size: 1.86 KB

Versions: 5

Compression:

Stored size: 1.86 KB

Contents

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2023-Present Couchbase, 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 <couchbase/search_query.hxx>

#include <optional>
#include <string>

namespace couchbase
{
/**
 * Allow to match `true`/`false` in a field mapped as boolean.
 *
 * @since 1.0.0
 * @committed
 */
class boolean_field_query : public search_query
{
  public:
    /**
     * Create a new boolean field query.
     *
     * @param value the input string to be matched against
     *
     * @since 1.0.0
     * @committed
     */
    explicit boolean_field_query(bool value)
      : bool_{ value }
    {
    }

    /**
     * If a field is specified, only terms in that field will be matched.
     *
     * @param field_name name of the field to be matched
     *
     * @return this query for chaining purposes.
     *
     * @since 1.0.0
     * @committed
     */
    auto field(std::string field_name) -> boolean_field_query&
    {
        field_ = std::move(field_name);
        return *this;
    }

    /**
     * @return encoded representation of the query.
     *
     * @since 1.0.0
     * @internal
     */
    [[nodiscard]] auto encode() const -> encoded_search_query override;

  private:
    bool bool_;
    std::optional<std::string> field_{};
};
} // namespace couchbase

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
couchbase-3.5.1 ext/couchbase/couchbase/boolean_field_query.hxx
couchbase-3.5.0 ext/couchbase/couchbase/boolean_field_query.hxx
couchbase-3.4.5 ext/couchbase/couchbase/boolean_field_query.hxx
couchbase-3.4.4 ext/couchbase/couchbase/boolean_field_query.hxx
couchbase-3.4.3 ext/couchbase/couchbase/boolean_field_query.hxx