Skip to main content

SettingsSchema

Struct SettingsSchema 

Source
pub struct SettingsSchema { /* private fields */ }
Expand description

An owned, recursively searchable snapshot of an OBS property tree.

Implementations§

Source§

impl SettingsSchema

Source

pub fn new(properties: Vec<PropertyMetadata>) -> Self

Source

pub fn properties(&self) -> &[PropertyMetadata]

Source

pub fn property(&self, name: &str) -> Option<&PropertyMetadata>

Finds a property by its OBS name, recursively descending through property groups.

Source

pub fn validate( &self, name: &str, value: &PropertyValue, ) -> Result<(), ObsError>

Validates a value against the runtime-discovered metadata without mutating OBS data.

Source

pub fn set( &self, settings: &mut ObsData, name: &str, value: PropertyValue, ) -> Result<(), ObsError>

Validates and applies one scalar property value to an ObsData object.

Source

pub fn value( &self, settings: &ObsData, name: &str, ) -> Result<Option<PropertyValue>, ObsError>

Reads a scalar property using the value category declared by this schema.

Source

pub fn snapshot( &self, current: &ObsData, defaults: Option<&ImmutableObsData>, ) -> Result<SettingsSnapshot, ObsError>

Joins this dynamic schema with current and default values into one form-ready snapshot.

Trait Implementations§

Source§

impl Clone for SettingsSchema

Source§

fn clone(&self) -> SettingsSchema

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SettingsSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SettingsSchema

Source§

fn default() -> SettingsSchema

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SettingsSchema

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SettingsSchema

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.