cedar_policy/lib.rs
1/*
2 * Copyright 2022-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
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 * https://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// Includes the cedar-policy README as the top-level documentation for this
18// crate. This also acts as a test that the example code in the README
19// compiles. If changing the docs away from using the readme verbatim, be sure
20// to add a separate test specifically for README examples by introducing a
21// private, empty, and unused function with `#[doc = include_str!("../README.md")]`.
22#![doc = include_str!("../README.md")]
23#![forbid(unsafe_code)]
24#![warn(rust_2018_idioms, clippy::pedantic, clippy::nursery)]
25#![deny(
26 missing_docs,
27 missing_debug_implementations,
28 rustdoc::broken_intra_doc_links,
29 rustdoc::private_intra_doc_links,
30 rustdoc::invalid_codeblock_attributes,
31 rustdoc::invalid_html_tags,
32 rustdoc::invalid_rust_codeblocks,
33 rustdoc::bare_urls,
34 clippy::doc_markdown
35)]
36#![allow(clippy::must_use_candidate, clippy::missing_const_for_fn)]
37
38/// Rust public API
39mod api;
40pub use api::*;
41
42/// Frontend utilities, see comments in the module itself
43pub mod frontend;
44
45mod tests;
46
47#[cfg(feature = "integration_testing")]
48pub mod integration_testing;