Props

vulcan.Props
See theProps companion object
sealed abstract class Props

Custom properties which can be included in a schema.

Use Props.one to create an instance, and Props#add to add more properties.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def add[A](name: String, value: A)(implicit codec: Codec[A]): Props

Returns a new Props instance including a property with the specified name and value.

Returns a new Props instance including a property with the specified name and value.

The value is encoded using the Codec.

Attributes

def toChain: Either[AvroError, Chain[(String, Any)]]

Returns a Chain of name-value pairs, where the value has been encoded with a Codec.

Returns a Chain of name-value pairs, where the value has been encoded with a Codec.

If encoding of any value resulted in error, instead returns the first such error.

Attributes