chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document error conditions for redact.

Browse Source
This commit is contained in:
Jimmy Cuadra 2019-07-12 02:55:49 -07:00
parent d578292471
commit 972388a019
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/functions.rs
View File

@ -706,6 +706,16 @@ fn canonical_json_with_fields_to_remove(value: &Value, fields: &[&str]) -> Resul
/// # Parameters /// # Parameters
/// ///
/// * value: A JSON object to redact. /// * value: A JSON object to redact.
///
/// # Errors
///
/// Returns an error if:
///
/// * `value` is not a JSON object.
/// * `value` contains a field called `content` that is not a JSON object.
/// * `value` contains a field called `hashes` that is not a JSON object.
/// * `value` contains a field called `signatures` that is not a JSON object.
/// * `value` is missing the `type` field or the field is not a JSON string.
pub fn redact(value: &Value) -> Result<Value, Error> { pub fn redact(value: &Value) -> Result<Value, Error> {
if !value.is_object() { if !value.is_object() {
return Err(Error::new("JSON value must be a JSON object")); return Err(Error::new("JSON value must be a JSON object"));