firebase:: firestore:: FieldPath
#include <field_path.h>
A FieldPath refers to a field in a document.
Summary
The path may consist of a single field name (referring to a top level field in the document) or a list of field names (referring to a nested field in the document).
Constructors and Destructors |
|
---|---|
FieldPath()
Creates an invalid FieldPath that has to be reassigned before it can be used.
|
|
FieldPath(std::initializer_list< std::string > field_names)
Creates a FieldPath from the provided field names.
|
|
FieldPath(const std::vector< std::string > & field_names)
Creates a FieldPath from the provided field names.
|
|
FieldPath(const FieldPath & other)
Copy constructor.
|
|
FieldPath(FieldPath && other)
Move constructor.
|
|
~FieldPath()
|
Friend classes |
|
---|---|
operator<<
|
friend std::ostream &
Outputs the string representation of this
FieldPath to the given stream. |
std::hash< FieldPath >
|
friend struct
|
Public functions |
|
---|---|
ToString() const
|
std::string
Returns a string representation of this
FieldPath for logging/debugging purposes. |
is_valid() const
|
bool
Returns true if this
FieldPath is valid, false if it is not valid. |
operator=(const FieldPath & other)
|
Copy assignment operator.
|
operator=(FieldPath && other) noexcept
|
Move assignment operator.
|
Public static functions |
|
---|---|
DocumentId()
|
A special sentinel FieldPath to refer to the ID of a document.
|
Friend classes
operator<<
friend std::ostream & operator<<(std::ostream &out, const FieldPath &path)
Outputs the string representation of this FieldPath
to the given stream.
See also:ToString()
for comments on the representation format.
std::hash< FieldPath >
friend struct std::hash< FieldPath >
Public functions
FieldPath
FieldPath()
FieldPath
FieldPath( std::initializer_list< std::string > field_names )
Creates a FieldPath from the provided field names.
If more than one field name is provided, the path will point to a nested field in a document.
Details | |||
---|---|---|---|
Parameters |
|
FieldPath
FieldPath( const std::vector< std::string > & field_names )
Creates a FieldPath from the provided field names.
If more than one field name is provided, the path will point to a nested field in a document.
Details | |||
---|---|---|---|
Parameters |
|
FieldPath
FieldPath( const FieldPath & other )
Copy constructor.
This performs a deep copy, creating an independent instance.
Details | |||
---|---|---|---|
Parameters |
|
FieldPath
FieldPath( FieldPath && other ) noexcept
ToString
std::string ToString() const
Returns a string representation of this FieldPath
for logging/debugging purposes.
is_valid
bool is_valid() const
~FieldPath
~FieldPath()