spdx

Crates.iospdx
lib.rsspdx
version0.10.7
sourcesrc
created_at2019-06-19 09:05:49.867951
updated_at2024-11-15 10:35:01.600781
descriptionHelper crate for SPDX expressions
homepagehttps://github.com/EmbarkStudios/spdx
repositoryhttps://github.com/EmbarkStudios/spdx
max_upload_size
id142078
size5,108,569
(embark-studios)

documentation

https://docs.rs/spdx

README

🆔 spdx

Helper crate for SPDX license expressions

Embark Embark Crates.io Docs Minimum Stable Rust Version SPDX Version dependency status Build Status

Usage

use spdx::Expression;

fn main() {
    let this_is_fine = Expression::parse("MIT OR Apache-2.0").unwrap();

    assert!(this_is_fine.evaluate(|req| {
        if let spdx::LicenseItem::Spdx { id, .. } = req.license {
            // Both MIT and Apache-2.0 are OSI approved, so this expression
            // evaluates to true
            return id.is_osi_approved();
        }

        false
    }));

    assert!(!this_is_fine.evaluate(|req| {
        if let spdx::LicenseItem::Spdx { id, .. } = req.license {
            // This is saying we don't accept any licenses that are OSI approved
            // so the expression will evaluate to false as both sides of the OR
            // are now rejected
            return !id.is_osi_approved();
        }

        false
    }));

    // `NOPE` is not a valid SPDX license identifier, so this expression
    // will fail to parse
    let _this_is_not = Expression::parse("MIT OR NOPE").unwrap_err();
}

Updating SPDX list

You can update the list of SPDX identifiers for licenses and exceptions by running the update program cargo run --manifest-path=update/Cargo.toml -- v3.6 where v3.6 is the tag in the SPDX data repo.

Contributing

Contributor Covenant

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 99

cargo fmt