polymorph/lib.rs
1/*
2 * Copyright © 2021 Anand Beh
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#![forbid(unsafe_code)]
18
19//!
20//! Currently only the ref_or_owned module is provided, but if or when
21//! more utilities are introduced, they will be placed into separate
22//! modules.
23//!
24
25///
26/// Contains abstractions over references and ownership. Provides types
27/// which may represent either a borrowed reference or an owned value.
28///
29/// Both sized and unsized types may be used. References may be either mutable
30/// or immutable. The right enum should be chosen on these bases.
31///
32pub mod ref_or_owned;