https://github.com/puripuri2100/opam-file-rs

Parser and printer for the opam file syntax with Rust
https://github.com/puripuri2100/opam-file-rs

opam parser rust

Last synced: 2 months ago
JSON representation

Parser and printer for the opam file syntax with Rust

• Host: GitHub
• URL: https://github.com/puripuri2100/opam-file-rs
• Owner: puripuri2100
• License: mit
• Created: 2021-02-15T15:10:27.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-03T14:13:04.000Z (over 3 years ago)
• Last Synced: 2024-09-29T06:41:10.189Z (3 months ago)
• Topics: opam, parser, rust
• Language: Rust
• Homepage:
• Size: 24.4 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# opam-file-rs: Parser and printer for the opam file syntax with Rust

[![crates.io][crates-badge]][crates]

[![docs.rs][docs-badge]][docs]

[![Build Status][ci-badge]][ci]

[![source badge][source-badge]][source]

[![license badge][license-badge]][license]

[crates]: https://crates.io/crates/opam-file-rs

[crates-badge]: https://img.shields.io/crates/v/opam-file-rs

[docs]: https://docs.rs/opam-file-rs/

[docs-badge]: https://img.shields.io/badge/docs.rs-opam_file_rs-blue

[ci]: https://github.com/puripuri2100/opam-file-rs/actions?query=workflow%3ACI

[ci-badge]: https://github.com/puripuri2100/opam-file-rs/workflows/CI/badge.svg?branch=master

[source]: https://github.com/puripuri2100/opam-file-rs

[source-badge]: https://img.shields.io/badge/source-github-blue

[license]: https://github.com/puripuri2100/opam-file-rs/blob/master/LICENSE

[license-badge]: https://img.shields.io/badge/license-MIT-blue

# Parsing OPAM

Parse OPAM file.

```rust

use opam_file_rs;

fn main () {

  let opam = r#"

    opam-version: "2.0"

    version: "0.1.0"

    name: "opam-file-rs"

    dev-repo: "git+https://github.com/puripuri2100/opam-file-rs"

    license: "MIT"

    maintainer: "Naoki Kaneko "

    depends: [

      "lalrpop-util" {>= "0.19.4"}

      "thiserror" {>= "1.0.23"}

    ]

  "#;

  assert!(opam_file_rs::parse(opam).is_ok());

}

```

# Convert to a OPAM file format.

A data structure can be converted to an OPAM file format by `value::format_opam_file`.

```rust

use opam_file_rs;

fn main() {

  let opam_str = r#"

    opam-version: "2.0"

    version: "0.1.0"

    name: "opam-file-rs"

    dev-repo: "git+https://github.com/puripuri2100/opam-file-rs"

    license: "MIT"

    maintainer: "Naoki Kaneko "

    depends: [

      "lalrpop-util" {>= "0.19.4"}

      "thiserror" {>= "1.0.23"}

    ]

  "#;

  let opam = opam_file_rs::parse(opam_str).unwrap();

  println!("{}", opam_file_rs::value::format_opam_file(opam));

}

```

---

(c) 2021 Naoki Kaneko (a.k.a. "puripuri2100")