kata-containers/regorus
1
0
Fork 0
mirror of https://github.com/microsoft/regorus.git synced 2026-08-05 02:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use correct docsrs feature annotation (#248)

Browse Source 
Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>
This commit is contained in:
Anand Krishnamoorthi
2024-05-23 11:31:09 -04:00
committed by GitHub
parent 3ac9b1121e
commit 3d08f6eef9
3 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/engine.rs
+4 -3
View File
@@ -95,6 +95,7 @@ impl Engine {
/// # } /// # }
/// ``` /// ```
#[cfg(feature = "std")] #[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn add_policy_from_file<P: AsRef<std::path::Path>>(&mut self, path: P) -> Result<String> { pub fn add_policy_from_file<P: AsRef<std::path::Path>>(&mut self, path: P) -> Result<String> {
let source = Source::from_file(path)?; let source = Source::from_file(path)?;
let mut parser = Parser::new(&source)?; let mut parser = Parser::new(&source)?;
@@ -644,7 +645,7 @@ impl Engine {
} }
#[cfg(feature = "coverage")] #[cfg(feature = "coverage")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "coverage")))] #[cfg_attr(docsrs, doc(cfg(feature = "coverage")))]
/// Get the coverage report. /// Get the coverage report.
/// ///
/// ```rust /// ```rust
@@ -688,7 +689,7 @@ impl Engine {
} }
#[cfg(feature = "coverage")] #[cfg(feature = "coverage")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "coverage")))] #[cfg_attr(docsrs, doc(cfg(feature = "coverage")))]
/// Enable/disable policy coverage. /// Enable/disable policy coverage.
/// ///
/// If `enable` is different from the current value, then any existing coverage /// If `enable` is different from the current value, then any existing coverage
@@ -698,7 +699,7 @@ impl Engine {
} }
#[cfg(feature = "coverage")] #[cfg(feature = "coverage")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "coverage")))] #[cfg_attr(docsrs, doc(cfg(feature = "coverage")))]
/// Clear the gathered policy coverage data. /// Clear the gathered policy coverage data.
pub fn clear_coverage_data(&mut self) { pub fn clear_coverage_data(&mut self) {
self.interpreter.clear_coverage_data() self.interpreter.clear_coverage_data()
src/lib.rs
-1
View File
@@ -3,7 +3,6 @@
// Use README.md as crate documentation. // Use README.md as crate documentation.
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))] #![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
#![cfg_attr(docsrs, feature(doc_cfg))]
// We'll default to building for no_std - use core, alloc instead of std. // We'll default to building for no_std - use core, alloc instead of std.
#![no_std] #![no_std]
src/value.rs
+5
View File
@@ -327,6 +327,7 @@ impl Value {
/// # } /// # }
/// ``` /// ```
#[cfg(feature = "std")] #[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn from_json_file<P: AsRef<std::path::Path>>(path: P) -> Result<Value> { pub fn from_json_file<P: AsRef<std::path::Path>>(path: P) -> Result<Value> {
match std::fs::read_to_string(&path) { match std::fs::read_to_string(&path) {
Ok(c) => Self::from_json_str(c.as_str()), Ok(c) => Self::from_json_str(c.as_str()),
@@ -400,6 +401,7 @@ impl Value {
/// Deserialize a value from YAML. /// Deserialize a value from YAML.
/// Note: Deserialization from YAML does not support arbitrary precision numbers. /// Note: Deserialization from YAML does not support arbitrary precision numbers.
#[cfg(feature = "yaml")] #[cfg(feature = "yaml")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn from_yaml_str(yaml: &str) -> Result<Value> { pub fn from_yaml_str(yaml: &str) -> Result<Value> {
Ok(serde_yaml::from_str(yaml)?) Ok(serde_yaml::from_str(yaml)?)
} }
@@ -408,6 +410,8 @@ impl Value {
/// Note: Deserialization from YAML does not support arbitrary precision numbers. /// Note: Deserialization from YAML does not support arbitrary precision numbers.
#[cfg(feature = "std")] #[cfg(feature = "std")]
#[cfg(feature = "yaml")] #[cfg(feature = "yaml")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
#[cfg_attr(docsrs, doc(cfg(feature = "yaml")))]
pub fn from_yaml_file(path: &String) -> Result<Value> { pub fn from_yaml_file(path: &String) -> Result<Value> {
match std::fs::read_to_string(path) { match std::fs::read_to_string(path) {
Ok(c) => Self::from_yaml_str(c.as_str()), Ok(c) => Self::from_yaml_str(c.as_str()),
@@ -609,6 +613,7 @@ impl From<serde_json::Value> for Value {
} }
#[cfg(feature = "yaml")] #[cfg(feature = "yaml")]
#[cfg_attr(docsrs, doc(cfg(feature = "yaml")))]
impl From<serde_yaml::Value> for Value { impl From<serde_yaml::Value> for Value {
/// Create a [`Value`] from [`serde_yaml::Value`]. /// Create a [`Value`] from [`serde_yaml::Value`].
/// ///