franz

Types

ClientBuilder

opaque </>

pub opaque type ClientBuilder

ClientConfig

</>

pub type ClientConfig {
  RestartDelaySeconds(Int)
  GetMetadataTimeoutSeconds(Int)
  ReconnectCoolDownSeconds(Int)
  AllowTopicAutoCreation(Bool)
  AutoStartProducers(Bool)
  DefaultProducerConfig(List(producer_config.ProducerConfig))
  UnknownTopicCacheTtl(Int)
}

Constructors

```
RestartDelaySeconds(Int)
```
```
GetMetadataTimeoutSeconds(Int)
```
```
ReconnectCoolDownSeconds(Int)
```
```
AllowTopicAutoCreation(Bool)
```
```
AutoStartProducers(Bool)
```

DefaultProducerConfig(List(producer_config.ProducerConfig))

```
UnknownTopicCacheTtl(Int)
```

FranzClient

</>

pub type FranzClient

FranzError

</>

pub type FranzError {
  UnknownError
  ClientDown
  UnknownTopicOrPartition
  ProducerDown
  TopicAlreadyExists
  ConsumerNotFound(String)
  ProducerNotFound(String, Int)
}

Constructors

```
UnknownError
```
```
ClientDown
```
```
UnknownTopicOrPartition
```
```
ProducerDown
```
```
TopicAlreadyExists
```
```
ConsumerNotFound(String)
```
```
ProducerNotFound(String, Int)
```

KafkaMessage

</>

pub type KafkaMessage {
  KafkaMessage(
    offset: Int,
    key: BitArray,
    value: BitArray,
    timestamp_type: TimeStampType,
    timestamp: Int,
    headers: List(#(String, String)),
  )
  KafkaMessageSet(
    topic: Topic,
    partition: Int,
    high_wm_offset: Int,
    messages: List(KafkaMessage),
  )
}

Constructors

KafkaMessage(
  offset: Int,
  key: BitArray,
  value: BitArray,
  timestamp_type: TimeStampType,
  timestamp: Int,
  headers: List(#(String, String)),
)

KafkaMessageSet(
  topic: Topic,
  partition: Int,
  high_wm_offset: Int,
  messages: List(KafkaMessage),
)

Offset

</>

pub type Offset =
  Int

Partition

</>

pub type Partition =
  Int

TimeStampType

</>

pub type TimeStampType {
  Undefined
  Create
  Append
}

Constructors

```
Undefined
```
```
Create
```
```
Append
```

Topic

</>

pub type Topic =
  String

Functions

create_topic

</>

pub fn create_topic(
  bootstrap_endpoints: List(#(String, Int)),
  topic: String,
  partitions: Int,
  replication_factor: Int,
) -> Result(Nil, FranzError)

fetch

</>

pub fn fetch(
  client: FranzClient,
  topic: String,
  partition: Int,
  offset: Int,
) -> Result(#(Int, KafkaMessage), FranzError)

new_client

</>

pub fn new_client(
  bootstrap_endpoints: List(#(String, Int)),
) -> ClientBuilder

start

</>

pub fn start(
  client_builder: ClientBuilder,
) -> Result(FranzClient, FranzError)

stop_client

</>

pub fn stop_client(client: FranzClient) -> Nil

with_config

</>

pub fn with_config(
  client_builder: ClientBuilder,
  client_config: ClientConfig,
) -> ClientBuilder