vstd/
vstd.rs

1//! The "standard library" for [Verus](https://github.com/verus-lang/verus).
2//! Contains various utilities and datatypes for proofs,
3//! as well as runtime functionality with specifications.
4//! For an introduction to Verus, see [the tutorial](https://verus-lang.github.io/verus/guide/).
5#![cfg_attr(not(feature = "std"), no_std)]
6#![allow(unused_parens)]
7#![allow(unused_imports)]
8#![allow(dead_code)]
9#![allow(unused_attributes)]
10#![allow(rustdoc::invalid_rust_codeblocks)]
11#![cfg_attr(verus_keep_ghost, feature(core_intrinsics))]
12#![cfg_attr(any(verus_keep_ghost, feature = "allocator"), feature(allocator_api))]
13#![cfg_attr(verus_keep_ghost, feature(step_trait))]
14#![cfg_attr(verus_keep_ghost, feature(ptr_metadata))]
15#![cfg_attr(verus_keep_ghost, feature(strict_provenance_atomic_ptr))]
16#![cfg_attr(verus_keep_ghost, feature(freeze))]
17#![cfg_attr(verus_keep_ghost, feature(derive_clone_copy))]
18#![cfg_attr(all(feature = "alloc", verus_keep_ghost), feature(liballoc_internals))]
19#![cfg_attr(verus_keep_ghost, feature(new_range_api))]
20
21#[cfg(feature = "alloc")]
22extern crate alloc;
23
24pub mod arithmetic;
25pub mod array;
26pub mod atomic;
27pub mod atomic_ghost;
28pub mod bits;
29pub mod bytes;
30pub mod calc_macro;
31pub mod cell;
32pub mod compute;
33pub mod contrib;
34pub mod float;
35pub mod function;
36#[cfg(all(feature = "alloc", feature = "std"))]
37pub mod hash_map;
38#[cfg(all(feature = "alloc", feature = "std"))]
39pub mod hash_set;
40pub mod invariant;
41#[cfg(verus_keep_ghost)]
42pub mod laws_cmp;
43#[cfg(verus_keep_ghost)]
44pub mod laws_eq;
45pub mod layout;
46pub mod logatom;
47pub mod map;
48pub mod map_lib;
49pub mod math;
50pub mod modes;
51pub mod multiset;
52pub mod multiset_lib;
53pub mod pcm;
54pub mod pcm_lib;
55pub mod pervasive;
56pub mod proph;
57pub mod raw_ptr;
58pub mod relations;
59pub mod rwlock;
60pub mod seq;
61pub mod seq_lib;
62pub mod set;
63pub mod set_lib;
64pub mod shared;
65#[cfg(feature = "alloc")]
66pub mod simple_pptr;
67pub mod slice;
68pub mod state_machine_internal;
69pub mod storage_protocol;
70pub mod string;
71#[cfg(feature = "std")]
72pub mod thread;
73pub mod tokens;
74pub mod view;
75
76#[cfg(verus_keep_ghost)]
77pub mod std_specs;
78
79// Re-exports all vstd types, traits, and functions that are commonly used or replace
80// regular `core` or `std` definitions.
81pub mod prelude;
82
83use prelude::*;
84
85verus! {
86
87#[cfg_attr(verus_keep_ghost, verifier::broadcast_use_by_default_when_this_crate_is_imported)]
88pub broadcast group group_vstd_default {
89    //
90    // basic Verus math, types, and features
91    //
92    seq::group_seq_axioms,
93    seq_lib::group_seq_lib_default,
94    map::group_map_axioms,
95    set::group_set_axioms,
96    set_lib::group_set_lib_default,
97    multiset::group_multiset_axioms,
98    compute::all_spec_ensures,
99    function::group_function_axioms,
100    laws_eq::group_laws_eq,
101    laws_cmp::group_laws_cmp,
102    //
103    // Rust types
104    //
105    slice::group_slice_axioms,
106    array::group_array_axioms,
107    string::group_string_axioms,
108    raw_ptr::group_raw_ptr_axioms,
109    layout::group_layout_axioms,
110    //
111    // core std_specs
112    //
113    std_specs::range::group_range_axioms,
114    std_specs::bits::group_bits_axioms,
115    std_specs::control_flow::group_control_flow_axioms,
116    std_specs::slice::group_slice_axioms,
117    //
118    // std_specs for alloc (with or without std)
119    //
120    #[cfg(feature = "alloc")]
121    std_specs::vec::group_vec_axioms,
122    #[cfg(feature = "alloc")]
123    std_specs::vecdeque::group_vec_dequeue_axioms,
124    //
125    // std_specs for alloc + std
126    //
127    #[cfg(all(feature = "alloc", feature = "std"))]
128    std_specs::hash::group_hash_axioms,
129}
130
131} // verus!
132// This allows us to use `$crate::vstd` or `crate::vstd` to refer to vstd
133// both in verus_verify_core mode (vstd is a module) and out (vstd is a crate)
134#[cfg(not(verus_verify_core))]
135#[doc(hidden)]
136pub use crate as vstd;
vstd/vstd.rs

vstd/
vstd.rs
