Struct regorust::Input

pub struct Input { /* private fields */ }

The Input interface allows the creation of inputs to a policy without requiring serialization to JSON. The interface is that of a stack, in which values are pushed and then various operations are used to turn terminal types into more complex ones like objects and arrays. When used, the Input will provide the top of the stack to any downstream consumer (such as Interpreter::set_input()).

Examples

Object

let input = Input::new().str("a").int(10).objectitem()
    .str("b").str("20").objectitem()
    .str("c").float(30.0).objectitem()
    .str("d").bool(true).objectitem()
    .object(4).validate()
    .expect("Unable to create input");
let rego = Interpreter::new();
rego.set_input(&input).expect("Unable to set input");
let result = rego.query("x=input.a").expect("Failed query");  
let x = result.binding("x").expect("cannot get x");
println!("x = {}", x.json().unwrap());

Array

let input = Input::new().int(1).int(2).int(3).int(4).array(4)
    .validate().expect("Unable to create input");
let rego = Interpreter::new();
rego.set_input(&input).expect("Unable to set input");
let result = rego.query("x=input").expect("Failed query");
let x = result.binding("x").expect("cannot get x");
println!("x = {}", x.json().unwrap());

Implementations

impl Input

pub fn new() -> Self

pub fn int(self, value: i64) -> Self

Push an integer onto the stack.

pub fn float(self, value: f64) -> Self

Push a float onto the stack.

pub fn str(self, value: &str) -> Self

Push a string onto the stack.

pub fn bool(self, value: bool) -> Self

Push a boolean onto the stack.

pub fn null(self) -> Self

Push a null onto the stack.

pub fn objectitem(self) -> Self

Take the top two values on the stack and turn them into an object item. The penultimate value on the stack will be used as the key, and the top of the stack will be the value for that key. Objects are constructed from object items.

Example

let input = Input::new().str("a").int(10).objectitem().object(1)
    .validate().expect("Unable to create input");

let rego = Interpreter::new();
rego.set_input(&input).expect("Unable to set input");
let result = rego.query("x=input").expect("Failed query");
let x = result.binding("x").expect("cannot get x");
println!("x = {}", x.json().unwrap());

pub fn object(self, size: regoSize) -> Self

Take the top size values on the stack and turn them into an object. Note that all of these values must be object items in order for this to be valid.

pub fn array(self, size: regoSize) -> Self

Take the top size values on the stack and turn them into an array. Stack order will be used.

Example

let input = Input::new().int(1).int(2).int(3).int(4).array(4)
    .validate().expect("Unable to create input");
let rego = Interpreter::new();
rego.set_input(&input).expect("Unable to set input");
let result = rego.query("x=input").expect("Failed query");
let x = result.binding("x").expect("cannot get x");
println!("x = {}", x.json().unwrap());

pub fn set(self, size: regoSize) -> Self

Take the top size values on the stack and turn them into a set. Identical items will be de-duplicated.

Example

let input = Input::new().int(1).int(2).int(2).int(3).set(4)
    .validate().expect("Unable to create input");
let rego = Interpreter::new();
rego.set_input(&input).expect("Unable to set input");
let result = rego.query("x=input").expect("Failed query");
let x = result.binding("x").expect("cannot get x");
println!("x = {}", x.json().unwrap());

pub fn validate(self) -> Result<Self, &'static str>

Trait Implementations

impl Debug for Input

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

Formats the value using the given formatter.

impl Drop for Input

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Input

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.