Fauna.QueryLiteral Class Reference

Represents a literal part of an FQL query. This class is used for embedding raw string values directly into the query structure. More...

Inheritance diagram for Fauna.QueryLiteral:

Public Member Functions
	QueryLiteral (string v)
	Initializes a new instance of the QueryLiteral class with the specified value.
override string	ToString ()
	Returns a string that represents the current QueryLiteral.
void	Serialize (MappingContext ctx, Utf8FaunaWriter writer)
	Serializes the query literal.
override bool	Equals (object? other)
	Determines whether the specified object is equal to the current QueryLiteral.
override int	GetHashCode ()
	The default hash function.
Public Member Functions inherited from Fauna.IQueryFragment

Static Public Member Functions
static bool	operator== (QueryLiteral left, QueryLiteral right)
	Determines whether two specified instances of QueryLiteral are equal.
static bool	operator!= (QueryLiteral left, QueryLiteral right)
	Determines whether two specified instances of QueryLiteral are not equal.

Properties
string	Unwrap [get]
	Gets the string value of the query literal.

Detailed Description

Represents a literal part of an FQL query. This class is used for embedding raw string values directly into the query structure.

Definition at line 9 of file QueryLiteral.cs.

Constructor & Destructor Documentation

QueryLiteral()

Fauna.QueryLiteral.QueryLiteral

(

string

v

)

Initializes a new instance of the QueryLiteral class with the specified value.

Parameters

v	The string value to be represented as a query literal.

Exceptions

ArgumentNullException

Thrown when the value is null.

Definition at line 16 of file QueryLiteral.cs.

Member Function Documentation

Equals()

override bool Fauna.QueryLiteral.Equals

(

object?

other

)

Determines whether the specified object is equal to the current QueryLiteral.

Parameters

other

The object to compare with the current QueryLiteral.

Returns

true if the specified object is equal to the current QueryLiteral; otherwise, false.

Definition at line 55 of file QueryLiteral.cs.

GetHashCode()

override int Fauna.QueryLiteral.GetHashCode

(

)

The default hash function.

Returns

A hash code for the current QueryLiteral.

Definition at line 81 of file QueryLiteral.cs.

operator!=()

static bool Fauna.QueryLiteral.operator!= ( QueryLiteral left, QueryLiteral right )

static

Determines whether two specified instances of QueryLiteral are not equal.

Parameters

left	The first QueryLiteral to compare.
right	The second QueryLiteral to compare.

Returns

true if left and right are not equal; otherwise, false.

Definition at line 103 of file QueryLiteral.cs.

operator==()

static bool Fauna.QueryLiteral.operator== ( QueryLiteral left, QueryLiteral right )

static

Determines whether two specified instances of QueryLiteral are equal.

Parameters

left	The first QueryLiteral to compare.
right	The second QueryLiteral to compare.

Returns

true if left and right are equal; otherwise, false.

Definition at line 92 of file QueryLiteral.cs.

Serialize()

void Fauna.QueryLiteral.Serialize	(	MappingContext	ctx,
		Utf8FaunaWriter	writer )

Serializes the query literal.

Parameters

ctx	The serialization context.
writer	The writer to serialize the query literal to.

Implements Fauna.IQueryFragment.

Definition at line 45 of file QueryLiteral.cs.

ToString()

override string Fauna.QueryLiteral.ToString

(

)

Returns a string that represents the current QueryLiteral.

Returns

A string that represents the current QueryLiteral.

Definition at line 35 of file QueryLiteral.cs.

Property Documentation

Unwrap

string Fauna.QueryLiteral.Unwrap

get

Gets the string value of the query literal.

Definition at line 29 of file QueryLiteral.cs.

---

The documentation for this class was generated from the following file:

• Fauna/Query/QueryLiteral.cs