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

vstd/
vstd.rs
