# Syslog-fmt

Formatter for the [5424](https://datatracker.ietf.org/doc/html/rfc5424) syslog standard.

[![Crates.io](https://img.shields.io/crates/v/syslog-fmt.svg?logo=rust)](https://crates.io/crates/syslog-fmt "Crates.io version")
[![Documentation](https://img.shields.io/docsrs/syslog_fmt/latest?logo=docs.rs)](https://docs.rs/syslog-fmt "Documentation")
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
[![GitHub actions](https://img.shields.io/github/actions/workflow/status/tandemdrive/syslog-fmt/ci.yml?branch=main)](https://github.com/tandemdrive/syslog-fmt/actions "CI")
[![GitHub activity](https://img.shields.io/github/last-commit/tandemdrive/syslog-fmt)](https://github.com/tandemdrive/syslog-fmt/commits "Commit activity")

This crate aims to provide a quality formatter for the 5424 spec.
We consciously limit the crate to the task of formatting to avoid entangling 
the separate concerns of formatting and transport.

Read through the [examples](examples) to see basic usages of the formatter with various transports.

## Why this crate?

- Minimal [dependencies](Cargo.toml)
- No [heap](tests/assert_no_heap_allocations_without_structured_data.rs) [allocations](tests/assert_no_heap_allocations_with_structured_data.rs) are performed.
- 100% safe Rust 🦀code upheld by [clippy](.cargo/config.toml) [workflow](.github/workflows/ci.yml)


## Contributing

We welcome community contributions to this project.

Please read our [Contributor Terms](CONTRIBUTING.md#contributor-terms) before
you make any contributions.

Any contribution intentionally submitted for inclusion, shall comply with the
Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed
as described below, without any additional terms or conditions:


### License

This contribution is dual licensed under EITHER OF

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

For clarity, "your" refers to TandemDrive or any other licensee/user of the contribution.