Struct filmreel::cut::Register

pub struct Register { /* fields omitted */ }

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

Cut Register

Methods

impl Register

pub fn new(json_string: &str) -> Result<Register, FrError>

Creates a new Register object running post deserialization validations

pub fn to_string_pretty(&self) -> String

Pretty json formatting for Frame serialization

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

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

Cut Variable

pub fn get(&self, key: &str) -> Option<&String>

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

Cut Variable

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

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 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,
    json_string: &mut String
) -> Result<(), FrError>

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

Read Operation

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

Takes a response payload value writes to the Cut Register

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

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

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<Self, __D::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::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Register