protobuf-kotlin-schemadocument/pro.felixo.protobuf.schemadocument

Package-level declarations

Types

data class Enum(val name: Identifier, val values: List<EnumValue>, val allowAlias: Boolean = false, val reservedNames: List<Identifier> = emptyList(), val reservedNumbers: List<IntRange> = emptyList()) : Type

Represents an enum declaration.

data class Field(val name: Identifier, val type: FieldType, val number: FieldNumber, val rule: FieldRule = FieldRule.Singular) : Member

Represents a field declaration inside a Message or a OneOf.

sealed class FieldType

The declared type of a Field.

sealed class Member : SchemaElement

Represents a member of a Message, which may be a Field or a OneOf.

data class Message(val name: Identifier, val members: List<Member> = emptyList(), val nestedTypes: List<Type> = emptyList(), val reservedNames: List<Identifier> = emptyList(), val reservedNumbers: List<IntRange> = emptyList()) : Type

Represents a message declaration.

data class OneOf(val name: Identifier, val fields: List<Field>) : Member

Represents a oneof declaration.

data class SchemaDocument(val types: List<Type> = emptyList()) : SchemaElement

Represents a .proto file and describes the declarations therein. Note that only a subset of the .proto syntax is supported.

SchemaDocumentReader

class SchemaDocumentReader(tokenizer: SchemaDocumentTokenizer = SchemaDocumentTokenizer())

Reads .proto syntax into SchemaDocuments. Note that only a subset of the .proto syntax is supported, and only the "proto3" syntax.

SchemaDocumentTokenizer

class SchemaDocumentTokenizer

Converts .proto syntax into sequences of tokens.

SchemaDocumentWriter

class SchemaDocumentWriter(out: StringBuilder, indentSpaces: Int = 2)

Converts SchemaDocuments to .proto syntax, in the "proto3" syntax.

interface SchemaElement

Common interface implemented by all the elements of a SchemaDocument. It serves to facilitate the generation of useful validation error messages.

sealed class Token

Represents a token in a .proto file.

enum TokenType : Enum<TokenType>

For each .proto token type, the regex that matches it and a function that converts the regex match into a Token.

sealed class Type : SchemaElement

Represents a type declaration, which may be a Message or an Enum.

Properties

val Message.fields: List<Field>

Returns all the fields of this message, including those inside oneof declarations.

val SCALARS: List<FieldType.Scalar<*>>

All FieldTypes that are FieldType.Scalars.

Functions

fun areEquivalent(member1: Member, member2: Member): Boolean

fun areEquivalent(schema1: SchemaDocument, schema2: SchemaDocument): Boolean

fun areEquivalent(type1: Type, type2: Type): Boolean