Avro C#
Public Member Functions | Properties | List of all members
Avro.LogicalSchema Class Reference

Class for logical type schemas. More...

Inheritance diagram for Avro.LogicalSchema:
Avro.UnnamedSchema Avro.Schema

Public Member Functions

override bool CanRead (Schema writerSchema)
 Checks if this schema can read data written by the given schema. Used for decoding data. More...
 
override bool Equals (object obj)
 Function to compare equality of two logical schemas More...
 
override int GetHashCode ()
 Hashcode function More...
 
- Public Member Functions inherited from Avro.Schema
override string ToString ()
 Returns the canonical JSON representation of this schema. More...
 
string GetProperty (string key)
 Returns the schema's custom property value given the property name More...
 
override int GetHashCode ()
 Hash code function More...
 

Properties

Schema BaseSchema [get]
 Schema for the underlying type that the logical type is based on. More...
 
string LogicalTypeName [get]
 The logical type name. More...
 
LogicalType LogicalType [get]
 The logical type implementation that supports this logical type. More...
 
- Properties inherited from Avro.UnnamedSchema
override string Name [get]
 
- Properties inherited from Avro.Schema
Type Tag [get]
 Schema type property More...
 
abstract string Name [get]
 If this is a record, enum or fixed, returns its name, otherwise the name the primitive type. More...
 
virtual string Fullname [get]
 The name of this schema. If this is a named schema such as an enum, it returns the fully qualified name for the schema. For other schemas, it returns the type of the schema. More...
 

Additional Inherited Members

- Public Types inherited from Avro.Schema
enum  Type {
  Type.Null, Type.Boolean, Type.Int, Type.Long,
  Type.Float, Type.Double, Type.Bytes, Type.String,
  Type.Record, Type.Enumeration, Type.Array, Type.Map,
  Type.Union, Type.Fixed, Type.Error, Type.Logical
}
 Enum for schema types More...
 
- Static Public Member Functions inherited from Avro.Schema
static Schema Parse (string json)
 Parses a given JSON string to create a new schema object More...
 
static string GetTypeString (Type type)
 Returns symbol name for the given schema type More...
 
static Schema.? Type ParseType (string type, bool removeQuotes=false)
 Parses the Schema.Type from a string. More...
 
- Protected Member Functions inherited from Avro.UnnamedSchema
 UnnamedSchema (Type type, PropertyMap props)
 Base constructor for an UnnamedSchema. More...
 
- Protected Member Functions inherited from Avro.Schema
 Schema (Type type, PropertyMap props)
 Constructor for schema class More...
 
- Static Protected Member Functions inherited from Avro.Schema
static bool areEqual (object o1, object o2)
 Compares two objects, null is equal to null More...
 
static int getHashCode (object obj)
 Hash code helper function More...
 

Detailed Description

Class for logical type schemas.

Member Function Documentation

◆ CanRead()

override bool Avro.LogicalSchema.CanRead ( Schema  writerSchema)
inlinevirtual

Checks if this schema can read data written by the given schema. Used for decoding data.

Parameters
writerSchemawriter schema
Returns
true if this and writer schema are compatible based on the AVRO specification, false otherwise

Reimplemented from Avro.Schema.

◆ Equals()

override bool Avro.LogicalSchema.Equals ( object  obj)
inline

Function to compare equality of two logical schemas

Parameters
objother logical schema
Returns
true if two schemas are equal, false otherwise

◆ GetHashCode()

override int Avro.LogicalSchema.GetHashCode ( )
inline

Hashcode function

Returns

Property Documentation

◆ BaseSchema

Schema Avro.LogicalSchema.BaseSchema
get

Schema for the underlying type that the logical type is based on.

◆ LogicalType

LogicalType Avro.LogicalSchema.LogicalType
get

The logical type implementation that supports this logical type.

◆ LogicalTypeName

string Avro.LogicalSchema.LogicalTypeName
get

The logical type name.


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