https://github.com/dvdsk/haproxy-config

Parser for haproxy config files
https://github.com/dvdsk/haproxy-config

haproxy haproxy-configuration parser rust

Last synced: 3 months ago
JSON representation

Parser for haproxy config files

• Host: GitHub
• URL: https://github.com/dvdsk/haproxy-config
• Owner: dvdsk
• License: mit
• Created: 2023-03-30T10:52:36.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-08-11T13:37:30.000Z (5 months ago)
• Last Synced: 2025-08-26T02:39:24.236Z (5 months ago)
• Topics: haproxy, haproxy-configuration, parser, rust
• Language: Rust
• Homepage:
• Size: 168 KB
• Stars: 4
• Watchers: 0
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HAProxy config

> **Parse HAProxy configs and easily query it**

[![Crates.io](https://img.shields.io/crates/v/haproxy_config?style=flat-square)](https://crates.io/crates/haproxy_config)

[![Crates.io](https://img.shields.io/crates/d/haproxy_config?style=flat-square)](https://crates.io/crates/haproxy_config)

[![Docs.rs](https://img.shields.io/docsrs/haproxy-config?style=flat-square)](https://docs.rs/haproxy_config)

[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT)

See also:

 - [API documentation](https://docs.rs/haproxy-config)

 - [Changelog](CHANGELOG.md)

A parser for HAProxy config files. HAProxy's config format offers many options, too many to build a completely typed API. Such an API would also be quite fragile to changes in the config format. This crate therefore presents a loosely typed config. 

It parses to [`sections`](section::borrowed::Section) consisting of [`lines`](line::borrowed::Line) from which a [`Config`](Config) struct can be made. The struct follows the sections of a HAProxy config. Most options within the sections are presented in a [`HashMap`](std::collections::HashMap) as key value strings. The important settings have a fully typed API.

### Example

List all the ports HAProxy will bind to from the config file.

```rust

use haproxy_config::parse_sections;

use haproxy_config::Config;

let file = include_str!("../tests/medium_haproxy.cfg");

let sections = parse_sections(file).unwrap();

let config = Config::try_from(&sections).unwrap();

let frontend_ports = config.frontends.values().map(|f| f.bind.addr.port);

let listen_ports = config.listen.values().map(|f| f.bind.addr.port);

let ports: Vec<_> = frontend_ports.chain(listen_ports).collect();

println!("ports bound to by haproxy: {ports:?}")

```

### Features

 - Zero copy parsing to a config section based representation which preserves the order of the config lines and any comments.

 - A stricter owned representation that is easy to query.

 - Clear error reporting on parsing errors featuring a debug formatter that shows the problem with the config being parsed.

 - Panic free implementation, this crate will not crash your code.

### Unsupported

Because the API is not fully typed the crate allows some invalid configs to parse. Specifically any invalid configuration inside a section will be interpreted as a configuration value. Sections end at the next section or the end of the file therefore any invalid configuration after the first section is undetected. 

The crate will break on valid configs that feature [conditional blocks](https://www.haproxy.com/documentation/hapee/latest/onepage/#2.4). 

### Contributions

This crate is far from complete but covers all my own use cases. I do however welcome any contributions.

### Thanks

- builds upon the PEG grammar written by [Joey](https://github.com/imjoey) for [pyhaproxy](https://github.com/imjoey/pyhaproxy)