// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SERVICES_STORAGE_PUBLIC_CPP_BUCKETS_BUCKET_LOCATOR_H_
#define COMPONENTS_SERVICES_STORAGE_PUBLIC_CPP_BUCKETS_BUCKET_LOCATOR_H_

#include "components/services/storage/public/cpp/buckets/bucket_id.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"

namespace storage {

// Information used to locate a bucket's data on disk or in databases.
//
// The information in a BucketLocator does not change throughout the bucket's
// lifetime.
struct COMPONENT_EXPORT(STORAGE_SERVICE_BUCKETS_SUPPORT) BucketLocator {
  // Creates null locator.
  BucketLocator();
  BucketLocator(BucketId bucket_id,
                blink::StorageKey storage_key,
                bool is_default);

  ~BucketLocator();

  static BucketLocator ForDefaultBucket(blink::StorageKey storage_key);

  BucketLocator(const BucketLocator&);
  BucketLocator(BucketLocator&&) noexcept;
  BucketLocator& operator=(const BucketLocator&);
  BucketLocator& operator=(BucketLocator&&) noexcept;

  bool is_null() const { return *this == BucketLocator(); }

  // Returns true if `this` and `other` refer to the same bucket.
  bool IsEquivalentTo(const BucketLocator& other) const;

  COMPONENT_EXPORT(STORAGE_SERVICE_BUCKETS_SUPPORT)
  friend bool operator==(const BucketLocator&, const BucketLocator&) = default;

  COMPONENT_EXPORT(STORAGE_SERVICE_BUCKETS_SUPPORT)
  friend auto operator<=>(const BucketLocator&, const BucketLocator&) = default;

  // Only positive IDs are valid. A default bucket without a specified bucket ID
  // can be represented by this struct when `id` is zero.
  BucketId id = BucketId::FromUnsafeValue(0);
  blink::StorageKey storage_key = blink::StorageKey();
  bool is_default = false;
};

// A comparator for maps that wish to take into account that default buckets can
// be represented with or without a bucket id.
struct COMPONENT_EXPORT(STORAGE_SERVICE_BUCKETS_SUPPORT) CompareBucketLocators {
  bool operator()(const BucketLocator& a, const BucketLocator& b) const;
};

}  // namespace storage

#endif  // COMPONENTS_SERVICES_STORAGE_PUBLIC_CPP_BUCKETS_BUCKET_LOCATOR_H_