View Source KafkaEx.Types (kafka_ex v0.15.0)

KafkaEx.Types This module contains basic types shared between KafkaEx modules

Summary

Types

Consumer group name UTF-8 encoded

Integer representing error code returned by kafka 0 means no error, any other value matches some error

Integer representing an offset of a given message Unique per topic/partition pair

Integer representing a partition number in topic

Representation of a Kafka timestamp in elixir as epoch in miliseconds

Representation of a Kafka timestamp request in elixir format

Topic name UTF-8 Encoded

Types

@type consumer_group_name() :: String.t()

Consumer group name UTF-8 encoded

@type error_code() :: integer()

Integer representing error code returned by kafka 0 means no error, any other value matches some error

@type offset() :: non_neg_integer() | -1

Integer representing an offset of a given message Unique per topic/partition pair

  • 0+ values is existing offset
  • -1 means offset does not exist
@type partition() :: non_neg_integer()

Integer representing a partition number in topic

@type timestamp() :: pos_integer()

Representation of a Kafka timestamp in elixir as epoch in miliseconds

@type timestamp_request() :: DateTime.t() | pos_integer() | :earliest | :latest

Representation of a Kafka timestamp request in elixir format

@type topic() :: String.t()

Topic name UTF-8 Encoded