Struct JsonRef

pub struct JsonRef { /* private fields */ }

Main struct that holds configuration for a JSONScheama derefferencing.

Instantiate with

use jsonref::JsonRef;
let jsonref = JsonRef::new();

Configuration is done through the set_ methods on the struct.

Implementations

impl JsonRef

pub fn new() -> JsonRef

Create a new instance of JsonRef.

pub fn set_reference_key(&mut self, reference_key: &str)

Set a key to store the data that the $ref replaced.

This example uses __reference__ as the key.

use serde_json::json;

let mut input  = json!(
    {"properties": {"prop1": {"title": "name"},
                    "prop2": {"$ref": "#/properties/prop1", "title": "old_title"}}
    }
);

let expected = json!(
    {"properties": {"prop1": {"title": "name"},
                    "prop2": {"title": "name", "__reference__": {"title": "old_title"}}}
    }
);
                                                                                          
let mut jsonref = JsonRef::new();

jsonref.set_reference_key("__reference__");

jsonref.deref_value(&mut input).unwrap();
                                                                                          
assert_eq!(input, expected)

pub fn deref_value(&mut self, value: &mut Value) -> Result<(), Error>

deref a serde_json value directly. Uses the current working directory for any relative refs.

pub fn deref_url(&mut self, url: &str) -> Result<Value, Error>

deref from a URL:

let mut jsonref = JsonRef::new();
let input_url = jsonref.deref_url("https://gist.githubusercontent.com/kindly/91e09f88ced65aaca1a15d85a56a28f9/raw/52f8477435cff0b73c54aacc70926c101ce6c685/base.json").unwrap();

pub fn deref_file(&mut self, file_path: &str) -> Result<Value, Error>

deref from a File:

let mut jsonref = JsonRef::new();
let file_example = jsonref
    .deref_file("fixtures/nested_relative/base.json")
    .unwrap();

Trait Implementations

impl Debug for JsonRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.