Struct dqcsim::common::types::ArbData

pub struct ArbData { /* fields omitted */ }

Represents an ArbData structure, consisting of an (unparsed, TODO) JSON string and a list of binary strings.

Methods

impl ArbData

pub fn from_str_args_only(s: &str) -> Result<Self>

Constructs an ArgData from a string containing only one or more unstructured binary arguments, using {} for the JSON object.

The unstructured binary strings are separated by commas. Furthermore, the following escape sequences are recognized:

• _, turns into a comma (,).
• __ turns into an underscore (_).
• _## where ## is a 2-digit hexadecimal string turns into a byte with the respective value.

To also parse a JSON object, use from_str(). To get an ArbData with the default JSON object and zero binary arguments, use default().

pub fn from_args(args: impl Into<Vec<Vec<u8>>>) -> Self

Construct an ArbData with just binary arguments and {} for the JSON/CBOR object.

pub fn from_cbor_unchecked(
    cbor: impl Into<Vec<u8>>,
    args: impl Into<Vec<Vec<u8>>>
) -> Self

Construct an ArbData from a CBOR object and binary arguments, without ensuring that the CBOR object is valid.

pub fn from_cbor(
    cbor: impl AsRef<[u8]>,
    args: impl Into<Vec<Vec<u8>>>
) -> Result<Self>

Construct an ArbData from a CBOR object and binary arguments, while ensuring that the CBOR object is valid.

pub fn from_json(
    json: impl AsRef<str>,
    args: impl Into<Vec<Vec<u8>>>
) -> Result<Self>

Construct an ArbData from a JSON object and binary arguments, while ensuring that the JSON object is valid.

pub fn get_json(&self) -> Result<String>

Returns the JSON/CBOR data field as a JSON string.

pub fn get_cbor(&self) -> &[u8]

Returns the JSON/CBOR data field as a CBOR string.

pub fn get_args(&self) -> &[Vec<u8>]

Provides a reference to the binary argument vector.

pub fn get_args_mut(&mut self) -> &mut Vec<Vec<u8>>

Provides a mutable reference to the binary argument vector.

pub fn set_json(&mut self, json: impl AsRef<str>) -> Result<()>

Sets the JSON/CBOR data field by means of a JSON string.

pub fn set_cbor(&mut self, cbor: impl AsRef<[u8]>) -> Result<()>

Sets the JSON/CBOR data field by means of a CBOR string.

pub fn set_cbor_unchecked(&mut self, cbor: impl Into<Vec<u8>>)

Sets the JSON/CBOR data field by means of a CBOR string without ensuring that the CBOR is valid.

pub fn set_args(&mut self, args: impl Into<Vec<Vec<u8>>>)

Provides a reference to the binary argument vector.

Trait Implementations

impl PartialEq<ArbData> for ArbData

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

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

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

This method tests for !=.

impl Default for ArbData

fn default() -> Self

Constructs an ArbData with JSON object {} and zero unstructured binary arguments.

impl Into<ArbData> for ArbCmd

fn into(self) -> ArbData

Performs the conversion.

impl Clone for ArbData

fn clone(&self) -> ArbData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArbData

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

Formats the value using the given formatter.

impl Display for ArbData

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

Turns the ArbData object into a string representation that can be parsed by from_str().

impl FromStr for ArbData

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Constructs an ArgData from its string representation.

The string starts with a JSON object. The object is followed by zero or more unstructured binary strings, which are separated by commas. The following escape sequences are recognized in the binary strings:

• _, turns into a comma (,).
• __ turns into an underscore (_).
• _## where ## is a 2-digit hexadecimal string turns into a byte with the respective value.

To omit the JSON object and substitute the default {}, use from_str_args_only(). To get an ArbData with the default JSON object and zero binary arguments, use default().

impl Serialize for ArbData

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ArbData

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

Deserialize this value from the given Serde deserializer.