Initial commit

Author: var-const

firestore/src/common/futures.h

@@ -55,8 +55,10 @@ template <typename T>
 Future<T> FailedFuture() {
   static auto* future = new Future<T>(FailedFuture<T>(
       Error::kErrorFailedPrecondition,
-      "This instance is in an invalid state. This is because the underlying "
-      "Firestore instance has been destructed."));
+      "The object that issued this future is in an invalid state. This can be "
+      "because:\n- the object was default-constructed and never reassigned;\n"
+      "- the object was moved from;\n- the Firestore instance with which the "
+      "object was associated has been destroyed."));
   return *future;
 }
 

firestore/src/include/firebase/firestore/document_change.h

@@ -159,6 +159,19 @@ class DocumentChange {
    */
   virtual std::size_t new_index() const;
 
+  /**
+   * @brief Returns true if this `DocumentChange` is valid, false if it is
+   * not valid. An invalid `DocumentChange` could be the result of:
+   *   - Creating a `DocumentChange` using the default constructor.
+   *   - Moving from the `DocumentChange`.
+   *   - Deleting your Firestore instance, which will invalidate all
+   *     `DocumentChange` instances associated with it.
+   *
+   * @return true if this `DocumentChange` is valid, false if this
+   * `DocumentChange` is invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
  private:
   friend class FirestoreInternal;
   friend class Wrapper;

firestore/src/include/firebase/firestore/document_reference.h

@@ -285,16 +285,17 @@ class DocumentReference {
           callback);
 
   /**
-   * @brief Returns true if this DocumentReference is valid, false if it is not
-   * valid. An invalid DocumentReference could be the result of:
-   *   - Creating a DocumentReference with the default constructor.
-   *   - Calling CollectionReference::Parent() on a CollectionReference that is
-   *     not a subcollection.
+   * @brief Returns true if this `DocumentReference` is valid, false if it is
+   * not valid. An invalid `DocumentReference` could be the result of:
+   *   - Creating a `DocumentReference` using the default constructor.
+   *   - Moving from the `DocumentReference`.
+   *   - Calling `CollectionReference::Parent()` on a `CollectionReference` that
+   *     is not a subcollection.
    *   - Deleting your Firestore instance, which will invalidate all
-   *     DocumentReference instances associated with it.
+   *     `DocumentReference` instances associated with it.
    *
-   * @return true if this DocumentReference is valid, false if this
-   * DocumentReference is invalid.
+   * @return true if this `DocumentReference` is valid, false if this
+   * `DocumentReference` is invalid.
    */
   bool is_valid() const { return internal_ != nullptr; }
 

firestore/src/include/firebase/firestore/document_snapshot.h

@@ -229,6 +229,19 @@ class DocumentSnapshot {
       const FieldPath& field,
       ServerTimestampBehavior stb = ServerTimestampBehavior::kDefault) const;
 
+  /**
+   * @brief Returns true if this `DocumentSnapshot` is valid, false if it is
+   * not valid. An invalid `DocumentSnapshot` could be the result of:
+   *   - Creating a `DocumentSnapshot` with the default constructor.
+   *   - Moving from the `DocumentSnapshot`.
+   *   - Deleting your Firestore instance, which will invalidate all
+   *     `DocumentSnapshot` instances associated with it.
+   *
+   * @return true if this `DocumentSnapshot` is valid, false if this
+   * `DocumentSnapshot` is invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
   /**
    * Returns a string representation of this `DocumentSnapshot` for
    * logging/debugging purposes.

firestore/src/include/firebase/firestore/field_path.h

@@ -122,6 +122,19 @@ class FieldPath final {
    */
   static FieldPath DocumentId();
 
+  /**
+   * @brief Returns true if this `FieldPath` is valid, false if it is not valid.
+   * An invalid `FieldPath` could be the result of:
+   *   - Creating a `FieldPath` using the default constructor.
+   *   - Moving from the `FieldPath`.
+   *   - Deleting your Firestore instance, which will invalidate all
+   *     `FieldPath` instances associated with it.
+   *
+   * @return true if this `FieldPath` is valid, false if this `FieldPath` is
+   * invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
   /**
    * Returns a string representation of this `FieldPath` for
    * logging/debugging purposes.

firestore/src/include/firebase/firestore/field_value.h

@@ -277,8 +277,9 @@ class FieldValue final {
    * @brief Returns `true` if this `FieldValue` is valid, `false` if it is not
    * valid. An invalid `FieldValue` could be the result of:
    *   - Creating a `FieldValue` using the default constructor.
+   *   - Moving from the `FieldValue`.
    *   - Calling `DocumentSnapshot::Get(field)` for a field that does not exist
-   * in the document.
+   *   in the document.
    *
    * @return `true` if this `FieldValue` is valid, `false` if this `FieldValue`
    * is invalid.

firestore/src/include/firebase/firestore/listener_registration.h

@@ -94,6 +94,19 @@ class ListenerRegistration {
    */
   virtual void Remove();
 
+  /**
+   * @brief Returns true if this `ListenerRegistration` is valid, false if it is
+   * not valid. An invalid `ListenerRegistration` could be the result of:
+   *   - Creating a `ListenerRegistration` using the default constructor.
+   *   - Moving from the `ListenerRegistration`.
+   *   - Deleting your Firestore instance, which will invalidate all
+   *     `ListenerRegistration` instances associated with it.
+   *
+   * @return true if this `ListenerRegistration` is valid, false if this
+   * `ListenerRegistration` is invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
  private:
   friend class DocumentReferenceInternal;
   friend class FirestoreInternal;

firestore/src/include/firebase/firestore/query.h

@@ -637,6 +637,18 @@ class Query {
       std::function<void(const QuerySnapshot&, Error, const std::string&)>
           callback);
 
+  /**
+   * @brief Returns true if this `Query` is valid, false if it is not valid. An
+   * invalid `Query` could be the result of:
+   *   - Creating a `Query` using the default constructor.
+   *   - Moving from the `Query`.
+   *   - Deleting your Firestore instance, which will invalidate all `Query`
+   *     instances associated with it.
+   *
+   * @return true if this `Query` is valid, false if this `Query` is invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
  private:
   friend bool operator==(const Query& lhs, const Query& rhs);
 

firestore/src/include/firebase/firestore/query_snapshot.h

@@ -150,6 +150,19 @@ class QuerySnapshot {
    */
   virtual std::size_t size() const;
 
+  /**
+   * @brief Returns true if this `QuerySnapshot` is valid, false if it is not
+   * valid. An invalid `QuerySnapshot` could be the result of:
+   *   - Creating a `QuerySnapshot` using the default constructor.
+   *   - Moving from the `QuerySnapshot`.
+   *   - Deleting your Firestore instance, which will invalidate all
+   *     `QuerySnapshot` instances associated with it.
+   *
+   * @return true if this `QuerySnapshot` is valid, false if this
+   * `QuerySnapshot` is invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
  private:
   friend class EventListenerInternal;
   friend class FirestoreInternal;

firestore/src/include/firebase/firestore/write_batch.h

@@ -157,6 +157,19 @@ class WriteBatch {
    */
   virtual Future<void> Commit();
 
+  /**
+   * @brief Returns true if this `WriteBatch` is valid, false if it is not
+   * valid. An invalid `WriteBatch` could be the result of:
+   *   - Creating a `WriteBatch` using the default constructor.
+   *   - Moving from the `WriteBatch`.
+   *   - Deleting your Firestore instance, which will invalidate all
+   *     `WriteBatch` instances associated with it.
+   *
+   * @return true if this `WriteBatch` is valid, false if this `WriteBatch` is
+   * invalid.
+   */
+  bool is_valid() const { return internal_ != nullptr; }
+
  private:
   friend class FirestoreInternal;
   friend class WriteBatchInternal;