Build Status codecov Apache 2.0 Licensed Rust Stable Rust 1.65+

itf-rs

Rust library for consuming Apalache ITF Traces.

Example

Trace: MissionariesAndCannibals.itf.json

```rust use serde::Deserialize;

use itf::{tracefromstr, ItfMap, ItfSet};

[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Deserialize)]

enum Bank { #[serde(rename = "N")] North,

#[serde(rename = "W")]
West,

#[serde(rename = "E")]
East,

#[serde(rename = "S")]
South,

}

[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Deserialize)]

enum Person { #[serde(rename = "c1OFPERSON")] Cannibal1,

#[serde(rename = "c2_OF_PERSON")]
Cannibal2,

#[serde(rename = "m1_OF_PERSON")]
Missionary1,

#[serde(rename = "m2_OF_PERSON")]
Missionary2,

}

[derive(Clone, Debug, Deserialize)]

struct State { pub bankofboat: Bank, pub whoison_bank: ItfMap>, }

let data = includestr!("../tests/fixtures/MissionariesAndCannibals.itf.json"); let trace: Trace = tracefrom_str(data).unwrap();

dbg!(trace); ```

Output:

rust trace = Trace { meta: TraceMeta { description: None, source: Some( "MC_MissionariesAndCannibalsTyped.tla", ), var_types: { "bank_of_boat": "Str", "who_is_on_bank": "Str -> Set(PERSON)", }, format: None, format_description: None, other: {}, }, params: [], vars: [ "bank_of_boat", "who_is_on_bank", ], loop_index: None, states: [ State { meta: StateMeta { index: Some( 0, ), other: {}, }, value: State { bank_of_boat: East, who_is_on_bank: { West: {}, East: { Missionary2, Cannibal1, Cannibal2, Missionary1, }, }, }, }, State { meta: StateMeta { index: Some( 1, ), other: {}, }, value: State { bank_of_boat: West, who_is_on_bank: { West: { Missionary2, Cannibal2, }, East: { Missionary1, Cannibal1, }, }, }, }, State { meta: StateMeta { index: Some( 2, ), other: {}, }, value: State { bank_of_boat: East, who_is_on_bank: { West: { Cannibal2, }, East: { Missionary2, Cannibal1, Missionary1, }, }, }, }, State { meta: StateMeta { index: Some( 3, ), other: {}, }, value: State { bank_of_boat: West, who_is_on_bank: { West: { Missionary1, Cannibal2, Missionary2, }, East: { Cannibal1, }, }, }, }, State { meta: StateMeta { index: Some( 4, ), other: {}, }, value: State { bank_of_boat: East, who_is_on_bank: { East: { Cannibal2, Cannibal1, }, West: { Missionary1, Missionary2, }, }, }, }, State { meta: StateMeta { index: Some( 5, ), other: {}, }, value: State { bank_of_boat: West, who_is_on_bank: { East: {}, West: { Cannibal1, Cannibal2, Missionary1, Missionary2, }, }, }, }, ], }

Versioning

We follow Semantic Versioning, though APIs are still under active development.

Resources

License

Copyright © 2023 Informal Systems Inc. and itf-rs authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this repository except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.