Struct obs_wrapper::data::DataObj

pub struct DataObj<'parent> { /* private fields */ }

A smart pointer to obs_data_t

Implementations

impl DataObj<'_>

pub fn new() -> Self

Creates a empty data object

pub fn from_json(json_str: impl Into<ObsString>) -> Option<Self>

Loads data into a object from a JSON string.

pub fn from_json_file(
    json_file: impl Into<ObsString>,
    backup_ext: impl Into<Option<ObsString>>
) -> Option<Self>

Loads data into a object from a JSON file.

• backup_ext: optional backup file path in case the original file is bad.

pub fn get<T: FromDataItem>(&self, name: impl Into<ObsString>) -> Option<T>

Fetches a property from this object. Numbers are implicitly casted.

pub fn set_default<T: FromDataItem>(
    &mut self,
    name: impl Into<ObsString>,
    value: impl Into<T>
)

Sets a default value for the key.

Notes

Setting a default value for a DataArray is not supported and will panic.

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

Creates a JSON representation of this object.

pub fn clear(&mut self)

Clears all values.

pub fn remove(&mut self, name: impl Into<ObsString>)

Trait Implementations

impl Default for DataObj<'_>

fn default() -> Self

Returns the “default value” for a type.

impl Drop for DataObj<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl FromDataItem for DataObj<'_>

fn typ() -> DataType

unsafe fn from_item_unchecked(item: *mut obs_data_item_t) -> Self

Safety

unsafe fn set_default_unchecked(obj: *mut obs_data_t, name: ObsString, val: Self)

Safety

impl PtrWrapper for DataObj<'_>

type Pointer = obs_data

unsafe fn from_raw(raw: *mut Self::Pointer) -> Self

Wraps the pointer into a owned wrapper.

fn as_ptr(&self) -> *const Self::Pointer

Returns the inner pointer.

fn into_raw(self) -> *mut Self::Pointer

Consumes the wrapper and transfers ownershop to the pointer

fn as_ptr_mut(&mut self) -> *mut Self::Pointer

Returns the inner pointer (mutable version).