https://github.com/kkrypt0nn/rsmanuf

📇 A very simple Rust library to get the manufacturer of a specific MAC address
https://github.com/kkrypt0nn/rsmanuf

mac mac-address mac-address-analyzer mac-address-generator mac-address-manufacturer mac-addresses manuf manufacturer rsmanuf rust rust-lang wireshark

Last synced: about 1 year ago
JSON representation

📇 A very simple Rust library to get the manufacturer of a specific MAC address

• Host: GitHub
• URL: https://github.com/kkrypt0nn/rsmanuf
• Owner: kkrypt0nn
• License: mit
• Created: 2023-10-17T19:05:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T01:21:59.000Z (over 1 year ago)
• Last Synced: 2024-10-24T11:35:29.779Z (over 1 year ago)
• Topics: mac, mac-address, mac-address-analyzer, mac-address-generator, mac-address-manufacturer, mac-addresses, manuf, manufacturer, rsmanuf, rust, rust-lang, wireshark
• Language: Rust
• Homepage: https://krypton.ninja
• Size: 1.24 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


# rsmanuf

[![Docs.rs Badge](https://img.shields.io/badge/docs.rs-rsmanuf-61c192.svg)](https://docs.rs/rsmanuf)

[![Crates.io Badge](https://img.shields.io/crates/v/rsmanuf.svg?color=fe7d37)](https://crates.io/crates/rsmanuf)

[![CI Badge](https://github.com/kkrypt0nn/rsmanuf/actions/workflows/ci.yml/badge.svg)](https://github.com/kkrypt0nn/rsmanuf/actions)

[![Dependency Status Badge](https://deps.rs/repo/github/kkrypt0nn/rsmanuf/status.svg)](https://deps.rs/repo/github/kkrypt0nn/rsmanuf)

[![Discord Server Badge](https://img.shields.io/discord/739934735387721768?logo=discord)](https://discord.gg/mTBrXyWxAF)

[![Last Commit Badge](https://img.shields.io/github/last-commit/kkrypt0nn/rsmanuf)](https://github.com/kkrypt0nn/rsmanuf/commits/main)

[![Conventional Commits Badge](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org/en/v1.0.0/)



---

A very simple Rust library to get the manufacturer of a specific MAC address

## Getting Started

### Installation

If you want to use this library for one of your projects, you can install it like any other Rust crate

```bash

cargo add rsmanuf

```

If you want to have the online indexing method to always use the most up to date version of the [`manuf.txt`](./src/manuf.txt) file, you need to install it with the `online` feature:

```bash

cargo add rsmanuf --features online

```

### Versioning

The versioning of the library is the following: `YYYY.MM.DD` where the leading `0` is **removed** from the version due to Crates.io not wanting leading zeroes.

Versions are automatically released every month on the first day of that month.

### Example Usage

#### Offline Lookup (preferred)

```rust

fn main() {

    match rsmanuf::lookup("C4:A8:1D:73:D7:8C") {

        Ok(manuf) => {

            println!("Manufacturer: {}", manuf)

        }

        Err(error) => {

            println!("Error: {}", error)

        }

    }

}

```

#### Online Lookup

> [!NOTE]

> The **`online`** feature needs to be enabled.

```rust

fn main() {

    match rsmanuf::online::lookup("C4:A8:1D:73:D7:8C") {

        Ok(manuf) => {

            println!("Manufacturer: {}", manuf)

        }

        Err(error) => {

            println!("Error: {}", error)

        }

    }

}

```

## Troubleshooting

If you have problems using the crate, you can open up an [issue](https://github.com/kkrypt0nn/rsmanuf/issues) or join my [Discord server](https://discord.gg/mTBrXyWxAF).

## Contributing

People may contribute by following the [Contributing Guidelines](./CONTRIBUTING.md) and

the [Code of Conduct](./CODE_OF_CONDUCT.md)

## License

This library was made with 💜 by Krypton and is under the [MIT License](./LICENSE.md).