Class StringFieldDefinition<TDocument, TField>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

A string based field name.

public sealed class StringFieldDefinition<TDocument, TField> : FieldDefinition<TDocument, TField>

Type Parameters

TDocument

The type of the document.

TField

The type of the field.

Inheritance

object

FieldDefinition<TDocument, TField>

StringFieldDefinition<TDocument, TField>

Inherited Members

FieldDefinition<TDocument, TField>.Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry)

FieldDefinition<TDocument, TField>.Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, bool)

FieldDefinition<TDocument, TField>.Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider, bool)

FieldDefinition<TDocument, TField>.Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StringFieldDefinition(string, IBsonSerializer<TField>)

Initializes a new instance of the StringFieldDefinition<TDocument, TField> class.

public StringFieldDefinition(string fieldName, IBsonSerializer<TField> fieldSerializer = null)

Parameters

fieldName string

Name of the field.

fieldSerializer IBsonSerializer<TField>

The field serializer.

Methods

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider)

Renders the field to a RenderedFieldDefinition<TField>.

public override RenderedFieldDefinition<TField> Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry, LinqProvider linqProvider)

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

linqProvider LinqProvider

The LINQ provider.

Returns

RenderedFieldDefinition<TField>

A RenderedFieldDefinition<TField>.

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider, bool)

Renders the field to a RenderedFieldDefinition<TField>.

public override RenderedFieldDefinition<TField> Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry, LinqProvider linqProvider, bool allowScalarValueForArrayField)

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

linqProvider LinqProvider

The LINQ provider.

allowScalarValueForArrayField bool

Whether a scalar value is allowed for an array field.

Returns

RenderedFieldDefinition<TField>

A RenderedFieldDefinition<TField>.