A general purpose writer of data from avro streams. This writer analyzes the writer schema when constructed so that writes can be more efficient. Once constructed, a writer can be reused or shared among threads to avoid incurring more resolution costs. More...

Inheritance diagram for Avro.Generic.PreresolvingDatumWriter< T >:

Classes
interface	ArrayAccess
	Defines the interface for a class that provides access to an array implementation. More...

class	DictionaryMapAccess
	Provides access to map properties from an IDictionary. More...

interface	EnumAccess
	Obsolete - This will be removed from the public API in a future version. More...

interface	MapAccess
	Defines the interface for a class that provides access to a map implementation. More...

class	RecordFieldWriter
	Correlates a record field with the writer used to serialize that field. More...

Public Member Functions

void Write (T datum, Encoder encoder)

Write a datum. Traverse the schema, depth first, writing each leaf value in the schema from the datum to the output.

Parameters

datum	Datum to write
encoder	Encoder to write to

Protected Member Functions
delegate void	WriteItem (object value, Encoder encoder)
	Defines the signature for a method that writes a value to an encoder.

	PreresolvingDatumWriter (Schema schema, ArrayAccess arrayAccess, MapAccess mapAccess)
	Initializes a new instance of the PreresolvingDatumWriter<T> class.

void	WriteNull (object value, Encoder encoder)
	Serializes a "null".

void	Write< TValue > (object value, Schema.Type tag, Writer< TValue > writer)
	A generic method to serialize primitive Avro types.

void	WriteRecordFields (object record, RecordFieldWriter[] writers, Encoder encoder)
	Writes each field of a record to the encoder.

void	EnsureRecordObject (RecordSchema recordSchema, object value)
	Ensures that the given value is a record and that it corresponds to the given schema. Throws an exception if either of those assertions are false.

void	WriteField (object record, string fieldName, int fieldPos, WriteItem writer, Encoder encoder)
	Writes a field from the record to the encoder using the writer .

WriteItem	ResolveEnum (EnumSchema es)
	Serializes an enumeration.

WriteItem	ResolveArray (ArraySchema schema)
	Creates a WriteItem delegate that serializes an array. The default implementation calls EnsureArrayObject() to ascertain that the given value is an array. It then calls GetArrayLength() and GetArrayElement() to access the members of the array and then serialize them.

WriteItem	ResolveLogical (LogicalSchema schema)
	Serializes a logical value object by using the underlying logical type to convert the value to its base value.

void	WriteMap (WriteItem itemWriter, object value, Encoder encoder)
	Serializes a map. The default implementation first ensure that the value is indeed a map and then uses GetMapSize() and GetMapElements() to access the contents of the map.

int	ResolveUnion (UnionSchema us, Schema[] branchSchemas, object obj)
	Finds the branch within the given UnionSchema that matches the given object. The default implementation calls Matches() method in the order of branches within the UnionSchema. If nothing matches, throws an exception.

void	WriteFixed (FixedSchema es, object value, Encoder encoder)
	Serialized a fixed object. The default implementation requires that the value is a GenericFixed object with an identical schema as es.

bool	UnionBranchMatches (Schema sc, object obj)
	Tests whether the given schema an object are compatible.

Static Protected Member Functions
static AvroException	TypeMismatch (object obj, string schemaType, string type)
	Creates a new AvroException and uses the provided parameters to build an exception message indicating there was a type mismatch.

Properties
Schema	Schema `[get]`
	Schema used to write the data.

Properties inherited from Avro.Generic.DatumWriter< T >

Detailed Description

A general purpose writer of data from avro streams. This writer analyzes the writer schema when constructed so that writes can be more efficient. Once constructed, a writer can be reused or shared among threads to avoid incurring more resolution costs.

Constructor & Destructor Documentation

◆ PreresolvingDatumWriter()

Avro.Generic.PreresolvingDatumWriter< T >.PreresolvingDatumWriter	(	Schema	schema,
		ArrayAccess	arrayAccess,
		MapAccess	mapAccess
	)

inlineprotected

Initializes a new instance of the PreresolvingDatumWriter<T> class.

Parameters

schema	Schema used by this writer
arrayAccess	Object used to access array properties
mapAccess	Object used to access map properties

Member Function Documentation

◆ EnsureRecordObject()

void Avro.Generic.PreresolvingDatumWriter< T >.EnsureRecordObject	(	RecordSchema	recordSchema,
		object	value
	)

abstractprotected

Ensures that the given value is a record and that it corresponds to the given schema. Throws an exception if either of those assertions are false.

Parameters

recordSchema	Schema associated with the record
value	Ensure this object is a record

◆ ResolveArray()

WriteItem Avro.Generic.PreresolvingDatumWriter< T >.ResolveArray ( ArraySchema schema )

inlineprotected

Creates a WriteItem delegate that serializes an array. The default implementation calls EnsureArrayObject() to ascertain that the given value is an array. It then calls GetArrayLength() and GetArrayElement() to access the members of the array and then serialize them.

Parameters

schema The ArraySchema for serialization

Returns: A WriteItem that serializes an array.

◆ ResolveEnum()

WriteItem Avro.Generic.PreresolvingDatumWriter< T >.ResolveEnum ( EnumSchema es )

abstractprotected

Serializes an enumeration.

Parameters

es	The EnumSchema for serialization

◆ ResolveLogical()

WriteItem Avro.Generic.PreresolvingDatumWriter< T >.ResolveLogical ( LogicalSchema schema )

inlineprotected

Serializes a logical value object by using the underlying logical type to convert the value to its base value.

Parameters

schema The logical schema.

◆ ResolveUnion()

int Avro.Generic.PreresolvingDatumWriter< T >.ResolveUnion	(	UnionSchema	us,
		Schema[]	branchSchemas,
		object	obj
	)

inlineprotected

Finds the branch within the given UnionSchema that matches the given object. The default implementation calls Matches() method in the order of branches within the UnionSchema. If nothing matches, throws an exception.

Parameters

us	The UnionSchema to resolve against
branchSchemas	Schemas for types within the union
obj	The object that should be used in matching

Returns: Index of the schema in branchSchemas that matches the obj .

Exceptions

AvroException No match found for the object in the union schema.

◆ TypeMismatch()

static AvroException Avro.Generic.PreresolvingDatumWriter< T >.TypeMismatch	(	object	obj,
		string	schemaType,
		string	type
	)

inlinestaticprotected

Creates a new AvroException and uses the provided parameters to build an exception message indicating there was a type mismatch.

Parameters

obj	Object whose type does not the expected type
schemaType	Schema that we tried to write against
type	Type that we expected

Returns: A new AvroException indicating a type mismatch.

◆ UnionBranchMatches()

bool Avro.Generic.PreresolvingDatumWriter< T >.UnionBranchMatches	(	Schema	sc,
		object	obj
	)

abstractprotected

Tests whether the given schema an object are compatible.

Parameters

sc	Schema to compare
obj	Object to compare

Returns: True if the two parameters are compatible, false otherwise.

◆ Write()

void Avro.Generic.PreresolvingDatumWriter< T >.Write	(	T	datum,
		Encoder	encoder
	)

inline

Write a datum. Traverse the schema, depth first, writing each leaf value in the schema from the datum to the output.

Parameters

datum	Datum to write
encoder	Encoder to write to

Implements Avro.Generic.DatumWriter< T >.

◆ Write< TValue >()

void Avro.Generic.PreresolvingDatumWriter< T >.Write< TValue >	(	object	value,
		Schema::Type	tag,
		Writer< TValue >	writer
	)

inlineprotected

A generic method to serialize primitive Avro types.

Template Parameters

TValue Type of the C# type to be serialized

Parameters

value	The value to be serialized
tag	The schema type tag
writer	The writer which should be used to write the given type.

◆ WriteField()

void Avro.Generic.PreresolvingDatumWriter< T >.WriteField	(	object	record,
		string	fieldName,
		int	fieldPos,
		WriteItem	writer,
		Encoder	encoder
	)

abstractprotected

Writes a field from the record to the encoder using the writer .

Parameters

record	The record value from which the field needs to be extracted
fieldName	The name of the field in the record
fieldPos	The position of field in the record
writer	Used to write the field value to the encoder
encoder	Encoder to write to

◆ WriteFixed()

void Avro.Generic.PreresolvingDatumWriter< T >.WriteFixed	(	FixedSchema	es,
		object	value,
		Encoder	encoder
	)

abstractprotected

Serialized a fixed object. The default implementation requires that the value is a GenericFixed object with an identical schema as es.

Parameters

es	The schema for serialization
value	The value to be serialized
encoder	The encoder for serialization

◆ WriteItem()

delegate void Avro.Generic.PreresolvingDatumWriter< T >.WriteItem	(	object	value,
		Encoder	encoder
	)

protected

Defines the signature for a method that writes a value to an encoder.

Parameters

value	Value to write
encoder	Encoder to write to

◆ WriteMap()

void Avro.Generic.PreresolvingDatumWriter< T >.WriteMap	(	WriteItem	itemWriter,
		object	value,
		Encoder	encoder
	)

inlineprotected

Serializes a map. The default implementation first ensure that the value is indeed a map and then uses GetMapSize() and GetMapElements() to access the contents of the map.

Parameters

itemWriter	Delegate used to write each map item.
value	The value to be serialized
encoder	The encoder for serialization

◆ WriteNull()

void Avro.Generic.PreresolvingDatumWriter< T >.WriteNull	(	object	value,
		Encoder	encoder
	)

inlineprotected

Serializes a "null".

Parameters

value	The object to be serialized using null schema
encoder	The encoder to use while serialization

◆ WriteRecordFields()

void Avro.Generic.PreresolvingDatumWriter< T >.WriteRecordFields	(	object	record,
		RecordFieldWriter[]	writers,
		Encoder	encoder
	)

abstractprotected

Writes each field of a record to the encoder.

Parameters

record	Record to write
writers	Writers for each field in the record
encoder	Encoder to write to

Property Documentation

◆ Schema

Schema Avro.Generic.PreresolvingDatumWriter< T >.Schema

get

Schema used to write the data.

Implements Avro.Generic.DatumWriter< T >.

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

src/apache/main/Generic/PreresolvingDatumWriter.cs

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PreresolvingDatumWriter()

Member Function Documentation

◆ EnsureRecordObject()

◆ ResolveArray()

◆ ResolveEnum()

◆ ResolveLogical()

◆ ResolveUnion()

◆ TypeMismatch()

◆ UnionBranchMatches()

◆ Write()

◆ Write< TValue >()

◆ WriteField()

◆ WriteFixed()

◆ WriteItem()

◆ WriteMap()

◆ WriteNull()

◆ WriteRecordFields()

Property Documentation

◆ Schema