3 releases (breaking)

0.3.0 Feb 5, 2024
0.2.0 Mar 31, 2022
0.1.0 Mar 31, 2022

#1252 in Math

MIT/Apache

28KB
494 lines

factordb-rust

Crates.io Version Crates.io License GitHub Actions Workflow Status

Rust wrapper for FactorDB API.

Includes a library as well as a simple command line app.

Command line app

Installation

cargo install factordb --all-features

Building from source

git clone https://github.com/megascrapper/factordb-rust
cd factordb-rust
cargo build --all-features

Command line usage

Rust wrapper for FactorDB API

Usage: factordb [OPTIONS] <NUMBER>

Arguments:
  <NUMBER>  Number to find its factor

Options:
      --unique   Print unique factors on each line
      --json     Print JSON output of FactorDB API
  -h, --help     Print help
  -V, --version  Print version

Library

Add dependency

cargo add factordb

Library usage example

use std::error::Error;
use factordb::FactorDbClient;
use num_bigint::BigInt; // All numeric values in the result object are of this type

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    // Initialise the client
    let client = FactorDbClient::new();

    // Make requests
    let forty_two = client.get(42).await?;
    let expect_factors: Vec<BigInt> = vec![2, 3, 7].into_iter().map(|n| BigInt::from(n)).collect();
    assert_eq!(forty_two.into_factors_flattened(), expect_factors);

    Ok(())
 }

Documentation

https://docs.rs/factordb/latest/factordb/

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.

Dependencies

~6–18MB
~264K SLoC