Skip to main content
Version: 1.0

Getting Started with Rust

Requirements​

Include the Library​

To include IOTA Identity in your project add it as a dependency in your Cargo.toml:

Latest Stable Release​

This version is published to crates.io and is stable, following semantic versioning.

[dependencies]
identity_iota = { version = "1.0.0" }

Development Release​

This version matches the main branch of this repository. It has all the latest features, but as such it may also have undocumented breaking changes.

[dependencies]
identity_iota = { git = "https://github.com/iotaledger/identity.rs", branch = "main"}

Examples​

To try out the examples, you should:

  1. Clone the repository:
git clone https://github.com/iotaledger/identity.rs
  1. Build the repository:
cargo build
  1. Run your first example:
cargo run --example getting_started

API Reference​

The API reference for the Rust library can be found on docs.rs.

If you would like to build the documentation locally you can do so with the following command:

RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc -p identity_iota --all-features --no-deps --open