Struct regorust::Output

pub struct Output { /* private fields */ }

Interface for the Rego output.

Outputs can either be examined as strings, or inspected using Rego Nodes. It is also possible to extract bindings for specific variables.

Examples

match result.to_str() {
  Ok(output_str) => {
    println!("{}", output_str);
  }
  Err(err_str) => {
    println!("error: {}", err_str);
  }
}

let x = result.binding("x").expect("cannot get x");
println!("x = {}", x.json().unwrap());

Implementations

impl Output

pub fn ok(&self) -> bool

Returns whether the output is ok.

The output of a successful query will always be a Node. However, if there was an error that arose with the Rego engine, then this Node will be of kind NodeKind::ErrorSeq and contain one or more errors. This method gives a quick way, without inspecting the result node, of finding whether it is ok.

pub fn to_str(&self) -> Result<&str, &str>

Returns the output as a JSON-encoded string.

If the result of Self::ok() is false, the result will be an string containing error information.

pub fn to_node(&self) -> Result<Node, Node>

Returns the output node.

The value of the Result enum will reflect the output of Self::ok().

pub fn binding_at_index( &self, index: regoSize, name: &str, ) -> Result<Node, Node>

Attempts to return the binding for the given variable name.

If the output is not OK or the variable is not bound, then this will return an Result::Err with the output node. Otherwise it will return the bound value for the variable.

pub fn binding(&self, name: &str) -> Result<Node, Node>

Attempts to return the binding for the given variable name.

If the output is not OK or the variable is not bound, then this will return an Result::Err with the output node. Otherwise it will return the bound value for the variable.

pub fn expressions_at_index(&self, index: regoSize) -> Result<Node, Node>

Attempts to return the expressions at a given result index.

pub fn expressions(&self) -> Result<Node, Node>

Attempts to return the expressions at a given result index.

pub fn size(&self) -> regoSize

Returns the number of results in the output.

Trait Implementations

impl Debug for Output

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

Formats the value using the given formatter.

impl Display for Output

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

Formats the value using the given formatter.

impl Drop for Output

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Output

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.