Struct SBStructuredData

pub struct SBStructuredData {
    pub raw: SBStructuredDataRef,
}

The value of a variable, register or expression.

Fields

raw: SBStructuredDataRef

The underlying raw SBStructuredDataRef.

Implementations

impl SBStructuredData

pub fn is_valid(&self) -> bool

Check whether or not this is a valid SBStructuredData value.

pub fn clear(&self)

pub fn set_from_json(&self, stream: &SBStream) -> Result<(), SBError>

pub fn get_as_json(&self) -> Result<SBStream, SBError>

pub fn data_type(&self) -> StructuredDataType

Return the type of data in this data structure.

pub fn size(&self) -> usize

Return the size (number of elements) in this data structure if it is an array or dictionary type. For other types, 0 will be returned.

pub fn keys(&self) -> SBStringList

Return the keys in the structured data if this data structure is a dictionary type.

pub fn value_for_key(&self, key: &str) -> Option<SBStructuredData>

Return the value corresponding to a key if this data structure is a dictionary type.

pub fn item_at_index(&self, idx: usize) -> Option<SBStructuredData>

Return the value corresponding to an index if this data structure is array.

pub fn integer_value(&self) -> Option<u64>

Return the integer value if this data structure is an integer type.

pub fn float_value(&self) -> Option<f64>

Return the floating point value if this data structure is a floating type.

pub fn boolean_value(&self) -> Option<bool>

Return the boolean value if this data structure is a boolean type.

pub fn string_value(&self) -> Option<String>

Provides the string value if this data structure is a string type.

Trait Implementations

impl Clone for SBStructuredData

fn clone(&self) -> SBStructuredData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SBStructuredData

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

Formats the value using the given formatter.

impl Drop for SBStructuredData

fn drop(&mut self)

Executes the destructor for this type.

impl Send for SBStructuredData

impl Sync for SBStructuredData