Struct filmreel::cut::Register

pub struct Register { /* private fields */ }

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

Cut Register

Implementations

impl Register

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

Creates a Register from a string ref

pub fn new() -> Self

pub fn to_string_pretty(&self) -> String

Pretty json formatting for Register serialization

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

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

Cut Variable

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

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 foreign Register structs into the caller, overriding any values in self with the current others.next() item.

1. if the primary key of an incoming record matches with the key of an existing record:
   • update the matching target record.
2. if the incoming key does not exist in any existing record:
   • add the incoming record to the target.

pub fn iter_merge<I>(registers: I) -> Register

where I: IntoIterator<Item = Register>,

Merges an iterable collection of registers together, left to right

pub fn single_merge(&mut self, other: Self)

Merges a single 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 crate::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

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 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: &Rhs) -> bool

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

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 TryFrom<PathBuf> for Register

type Error = FrError

The type returned in the event of a conversion error.

fn try_from(path: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<PathBuf>> for Register

type Error = FrError

The type returned in the event of a conversion error.

fn try_from(paths: Vec<PathBuf>) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Register