Enum KafkaValueFormat 

pub enum KafkaValueFormat {
    Json,
    RawString,
    Bytes,
    ConfluentAvro {
        schema_registry: SchemaRegistryConfig,
    },
    ConfluentProtobuf {
        schema_registry: SchemaRegistryConfig,
    },
    ConfluentJsonSchema {
        schema_registry: SchemaRegistryConfig,
        validate: bool,
    },
}

How a Kafka message value (or key) is encoded on the wire.

Variants

Json

Parse value bytes as a JSON document.

RawString

Treat value bytes as a UTF-8 string. Invalid UTF-8 fails per OnDecodeError.

Bytes

Pass value bytes through as a base64-encoded string inside the JSON record. On the sink side, expects a base64 string in the source record.

ConfluentAvro

Available on crate feature schema-registry only.

Confluent-wire-format Avro: magic byte + schema_id + Avro binary.

Fields

schema_registry: SchemaRegistryConfig

ConfluentProtobuf

Available on crate feature schema-registry only.

Confluent-wire-format Protobuf: magic byte + schema_id + protobuf binary.

Fields

schema_registry: SchemaRegistryConfig

ConfluentJsonSchema

Available on crate feature schema-registry only.

Confluent-wire-format JSON Schema: magic byte + schema_id + JSON payload. When validate is true, decoded JSON is validated against the registered schema.

Fields

schema_registry: SchemaRegistryConfig

validate: bool

Implementations

impl KafkaValueFormat

pub fn is_schema_registry(&self) -> bool

True for Confluent Schema Registry wire formats (ConfluentAvro, ConfluentProtobuf, ConfluentJsonSchema), which require a schema to encode on the sink side. Always false when the schema-registry feature is disabled (those variants don’t exist).

Trait Implementations

impl Clone for KafkaValueFormat

fn clone(&self) -> KafkaValueFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KafkaValueFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for KafkaValueFormat

fn default() -> KafkaValueFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KafkaValueFormat

fn deserialize<__D>( __deserializer: __D, ) -> Result<KafkaValueFormat, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for KafkaValueFormat

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for KafkaValueFormat

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.