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

vstd/
vstd.rs
