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(sized_hierarchy))]
16#![cfg_attr(verus_keep_ghost, feature(freeze))]
17#![cfg_attr(verus_keep_ghost, feature(derive_clone_copy_internals))]
18#![cfg_attr(verus_keep_ghost, feature(derive_eq_internals))]
19#![cfg_attr(verus_keep_ghost, feature(slice_index_methods))]
20#![cfg_attr(all(feature = "alloc", verus_keep_ghost), feature(liballoc_internals))]
21#![cfg_attr(verus_keep_ghost, feature(new_range_api))]
22
23#[cfg(feature = "alloc")]
24extern crate alloc;
25
26pub mod arithmetic;
27pub mod array;
28pub mod atomic;
29pub mod atomic_ghost;
30pub mod bits;
31pub mod bytes;
32pub mod calc_macro;
33pub mod cell;
34pub mod compute;
35pub mod contrib;
36pub mod endian;
37pub mod float;
38pub mod function;
39#[cfg(feature = "std")]
40pub mod future;
41#[cfg(all(feature = "alloc", feature = "std"))]
42pub mod hash_map;
43#[cfg(all(feature = "alloc", feature = "std"))]
44pub mod hash_set;
45pub mod invariant;
46#[cfg(verus_keep_ghost)]
47pub mod laws_cmp;
48#[cfg(verus_keep_ghost)]
49pub mod laws_eq;
50pub mod layout;
51pub mod logatom;
52pub mod map;
53pub mod map_lib;
54pub mod math;
55pub mod modes;
56pub mod multiset;
57pub mod multiset_lib;
58pub mod pervasive;
59pub mod predicate;
60pub mod proph;
61pub mod raw_ptr;
62pub mod relations;
63pub mod resource;
64pub mod rwlock;
65pub mod seq;
66pub mod seq_lib;
67pub mod set;
68pub mod set_lib;
69pub mod shared;
70#[cfg(feature = "alloc")]
71pub mod simple_pptr;
72pub mod slice;
73pub mod state_machine_internal;
74pub mod string;
75#[cfg(feature = "std")]
76pub mod thread;
77pub mod tokens;
78pub mod utf8;
79pub mod view;
80pub mod wrapping;
81
82#[cfg(verus_keep_ghost)]
83pub mod std_specs;
84
85// Re-exports all vstd types, traits, and functions that are commonly used or replace
86// regular `core` or `std` definitions.
87pub mod prelude;
88
89use prelude::*;
90
91verus! {
92
93#[cfg_attr(verus_keep_ghost, verifier::broadcast_use_by_default_when_this_crate_is_imported)]
94pub broadcast group group_vstd_default {
95    //
96    // basic Verus math, types, and features
97    //
98    seq::group_seq_axioms,
99    seq_lib::group_seq_lib_default,
100    map::group_map_axioms,
101    set::group_set_axioms,
102    set_lib::group_set_lib_default,
103    multiset::group_multiset_axioms,
104    compute::all_spec_ensures,
105    function::group_function_axioms,
106    laws_eq::group_laws_eq,
107    laws_cmp::group_laws_cmp,
108    //
109    // Rust types
110    //
111    slice::group_slice_axioms,
112    array::group_array_axioms,
113    #[cfg(not(verus_verify_core))]
114    string::group_string_axioms,
115    raw_ptr::group_raw_ptr_axioms,
116    layout::group_layout_axioms,
117    //
118    // core std_specs
119    //
120    std_specs::range::group_range_axioms,
121    std_specs::bits::group_bits_axioms,
122    std_specs::control_flow::group_control_flow_axioms,
123    std_specs::slice::group_slice_axioms,
124    std_specs::manually_drop::group_manually_drop_axioms,
125    std_specs::iter::group_iter_axioms,
126    //
127    // std_specs for alloc (with or without std)
128    //
129    #[cfg(feature = "alloc")]
130    std_specs::vec::group_vec_axioms,
131    #[cfg(feature = "alloc")]
132    std_specs::vecdeque::group_vec_dequeue_axioms,
133    //
134    // std_specs for alloc + std
135    //
136    #[cfg(all(feature = "alloc", feature = "std"))]
137    std_specs::hash::group_hash_axioms,
138    #[cfg(feature = "alloc")]
139    std_specs::btree::group_btree_axioms,
140}
141
142} // verus!
143// This allows us to use `$crate::vstd` or `crate::vstd` to refer to vstd
144// both in verus_verify_core mode (vstd is a module) and out (vstd is a crate)
145#[cfg(not(verus_verify_core))]
146#[doc(hidden)]
147pub use crate as vstd;
vstd/vstd.rs

vstd/
vstd.rs
