Struct darkroom::Frame

pub struct Frame<'a> {
    pub protocol: Protocol,
    pub cut: InstructionSet<'a>,
    pub response: Response,
    // some fields omitted
}

Represents the entire deserialized frame file.

Frame spec

Fields

protocol: Protocol

cut: InstructionSet<'a>

response: Response

Implementations

impl<'a> Frame<'a>

pub fn new(json_string: &str) -> Result<Frame<'_>, FrError>

Creates a new Frame object running post deserialization validations

pub fn to_value(&self) -> Value

Serializes the Frame struct to a serde_json::Value

pub fn get_request(&self) -> Request

Serialized payload

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

Serialized payload

pub fn get_response_value(&self) -> Result<Value, Error>

Returns a Value object from the response body, used for response comparisons and writing to the cut register

pub fn hydrate(&mut self, reg: &Register, hide: bool) -> Result<(), FrError>

Traverses Frame properties where Read Operations are permitted and performs Register.read_operation on Strings with Cut Variables

pub fn hydrate_val(
    set: &InstructionSet<'_>,
    val: &mut Value,
    reg: &Register,
    hide: bool
) -> Result<(), FrError>

Traverses a given serde::Value enum attempting to modify found Strings for the moment this method also works as a Frame.init() check, emitting FrameParseErrors

Trait Implementations

impl<'a> Clone for Frame<'a>

fn clone(&self) -> Frame<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Frame<'a> where
    'de: 'a, 

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

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<Frame<'a>> for Frame<'a>

fn eq(&self, other: &Frame<'a>) -> bool

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

fn ne(&self, other: &Frame<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for Frame<'a>

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.