Struct darkroom::Register

pub struct Register { /* fields omitted */ }

Holds Cut Variables and their corresponding values stored in a series of key/value pairs.

Cut Register

Implementations

impl Register

pub fn from<T>(json_string: T) -> Result<Register, FrError> where
    T: AsRef<str>, 

Creates a Register from a string ref

pub fn new() -> Register

pub fn to_string_pretty(&self) -> String

Pretty json formatting for Register serialization

pub fn get_key_value<K>(&self, key: K) -> Option<(&String, &Value)> where
    K: AsRef<str>, 

Gets a reference to the string slice value for the given var name.

Cut Variable

pub fn get<K>(&self, key: K) -> Option<&Value> where
    K: AsRef<str>, 

Gets a reference to the string slice value for the given var name.

Cut Variable

pub fn iter(&self) -> Iter<String, Value>

An iterator visiting all Cut Variables in arbitrary order.

pub fn contains_key(&self, key: &str) -> bool

Returns a boolean indicating whether Register.vars contains a given key.

Cut Variable

pub fn destructive_merge<I>(&mut self, others: I) where
    I: IntoIterator<Item = Register>, 

Merges a foreign Cut register into the caller, overriding any values in self with other

pub fn read_match(&self, json_string: &str) -> Result<Vec<Match>, FrError>

Returns a vector of Match enums enums found in the string provided for use in cut operations.

Read Operation

pub fn read_operation(
    &self,
    mat: Match,
    value: &mut Value,
    hide_vars: bool
) -> Result<(), FrError>

Replaces a byte range in a given string with the range given in the ::Match provided.

Read Operation

pub fn expect_standalone_var(
    var_name: &str,
    frame_str: &str
) -> Result<(), FrError>

pub fn write_match(
    var_name: &str,
    frame_str: &str,
    payload_str: &str
) -> Result<Option<String>, FrError>

Takes a frame string value and compares it against a payload string value returning any declared cut variables found

pub fn write_operation(
    &mut self,
    key: &str,
    val: Value
) -> Result<Option<Value>, FrError>

Inserts a Value entry into the Register's Cut Variables

Returns an Err if the key value is does not consist solely of characters, dashes, and underscores.

pub fn flush_ignored(&mut self)

Flushes lowercase/ignored variable patters

Trait Implementations

impl Clone for Register

fn clone(&self) -> Register

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Register

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

Formats the value using the given formatter.

impl Default for Register

fn default() -> Register

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Register

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Register, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Register> for Register

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

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

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

This method tests for !=.

impl Serialize for Register

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Register

impl<'a> ToStringHidden for &'a Register

fn to_string_hidden(&self) -> Result<String, FrError>

Pretty formatting for Register serialization, any variables starting with an underscore as it's value hidden