SBStructuredData#

class lldb.SBStructuredData(*args)#

A class representing a StructuredData event.

This class wraps the event type generated by StructuredData features.

Attributes Summary

dynamic

Methods Summary

`Clear`(SBStructuredData self)
`GetAsJSON`(SBStructuredData self, SBStream stream)
`GetBooleanValue`([fail_value])	Return the boolean value if this data structure is a boolean type.
`GetDescription`(SBStructuredData self, ...)
`GetFloatValue`([fail_value])	Return the floating point value if this data structure is a floating type.
`GetGenericValue`()	Return the generic pointer if this data structure is a generic type.
`GetIntegerValue`(SBStructuredData self, ...)
`GetItemAtIndex`(idx)	Return the value corresponding to an index if this data structure is array.
`GetKeys`(keys)	Fill keys with the keys in this object and return true if this data structure is a dictionary.
`GetSignedIntegerValue`([fail_value])	Return the integer value if this data structure is an integer type.
`GetSize`()	Return the size (i.e. number of elements) in this data structure if it is an array or dictionary type.
`GetStringValue`(dst)	Provides the string value if this data structure is a string type.
`GetType`()	Return the type of data in this data structure
`GetUnsignedIntegerValue`([fail_value])	Return the integer value if this data structure is an integer type.
`GetValueForKey`(key)	Return the value corresponding to a key if this data structure is a dictionary type.
`IsValid`(SBStructuredData self)
`SetBooleanValue`(value)	Change the type to boolean and overwrite the previous data with the new value.
`SetFloatValue`(value)	Change the type to float and overwrite the previous data with the new value.
`SetFromJSON`(-> SBError)
`SetGenericValue`(value)	Change the type to generic and overwrite the previous data with the new value.
`SetSignedIntegerValue`(value)	Change the type to signed interger and overwrite the previous data with the new value.
`SetStringValue`(value)	Change the type to string and overwrite the previous data with the new value.
`SetUnsignedIntegerValue`(value)	Change the type to unsigned interger and overwrite the previous data with the new value.
`SetValueForKey`(key, value)	Set the value corresponding to a key.
`type_name`(t)

Attributes Documentation

dynamic#

Methods Documentation

Clear(SBStructuredData self)#

GetAsJSON(SBStructuredData self, SBStream stream) → SBError#

GetBooleanValue(fail_value=False)#: Return the boolean value if this data structure is a boolean type.

GetDescription(SBStructuredData self, SBStream stream) → SBError#

GetFloatValue(fail_value=0.0)#: Return the floating point value if this data structure is a floating type.

GetGenericValue()#: Return the generic pointer if this data structure is a generic type.

GetIntegerValue(SBStructuredData self, uint64_t fail_value=0) → uint64_t#

GetItemAtIndex(idx)#: Return the value corresponding to an index if this data structure is array.

GetKeys(keys)#: Fill keys with the keys in this object and return true if this data structure is a dictionary. Returns false otherwise.

GetSignedIntegerValue(fail_value=0)#: Return the integer value if this data structure is an integer type.

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

GetStringValue(dst)#

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

Parameters:

dst (string, out) – pointer where the string value will be written. In case it is null, nothing will be written at dst.
dst_len (int, in) – max number of characters that can be written at dst. In case it is zero, nothing will be written at dst. If this length is not enough to write the complete string value, (dst_len - 1) bytes of the string value will be written at dst followed by a null character.

Return type:

int

Returns:

Returns the byte size needed to completely write the string value at dst in all cases.

GetType()#: Return the type of data in this data structure

GetUnsignedIntegerValue(fail_value=0)#: Return the integer value if this data structure is an integer type.

GetValueForKey(key)#: Return the value corresponding to a key if this data structure is a dictionary type.

IsValid(SBStructuredData self) → bool#

SetBooleanValue(value)#: Change the type to boolean and overwrite the previous data with the new value.

SetFloatValue(value)#: Change the type to float and overwrite the previous data with the new value.

SetFromJSON(SBStructuredData self, SBStream stream) → SBError#
SetFromJSON(SBStructuredData self, char const * json) → SBError

SetGenericValue(value)#: Change the type to generic and overwrite the previous data with the new value.

SetSignedIntegerValue(value)#: Change the type to signed interger and overwrite the previous data with the new value.

SetStringValue(value)#: Change the type to string and overwrite the previous data with the new value.

SetUnsignedIntegerValue(value)#: Change the type to unsigned interger and overwrite the previous data with the new value.

SetValueForKey(key, value)#: Set the value corresponding to a key. If this data structure is not a dictionary type, reset the type to be dictionary and overwrite the previous data.

static type_name(t)#