Struct wireplumber::spa::SpaPod

pub struct SpaPod { /* private fields */ }

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl SpaPod

pub fn as_ptr(&self) -> *mut WpSpaPod

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const *const WpSpaPod) -> &'a Self

Borrows the underlying C value.

impl SpaPod

pub fn new_boolean(value: bool) -> SpaPod

pub fn new_double(value: f64) -> SpaPod

pub fn new_fd(value: i64) -> SpaPod

pub fn new_float(value: f32) -> SpaPod

pub fn new_fraction(num: u32, denom: u32) -> SpaPod

pub fn new_id(value: u32) -> SpaPod

pub fn new_int(value: i32) -> SpaPod

pub fn new_long(value: i64) -> SpaPod

pub fn new_none() -> SpaPod

pub fn new_rectangle(width: u32, height: u32) -> SpaPod

pub fn new_string(value: &str) -> SpaPod

pub fn copy(&self) -> Option<SpaPod>

pub fn ensure_unique_owner(self) -> Option<SpaPod>

pub fn filter(&self, filter: &SpaPod) -> Option<SpaPod>

pub fn fixate(&self) -> bool

pub fn array_child(&self) -> Option<SpaPod>

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

pub fn choice_child(&self) -> Option<SpaPod>

pub fn control(&self) -> Option<(u32, GString, SpaPod)>

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

pub fn fd(&self) -> Option<i64>

pub fn float(&self) -> Option<f32>

pub fn fraction(&self) -> Option<(u32, u32)>

pub fn id(&self) -> Option<u32>

pub fn int(&self) -> Option<i32>

pub fn long(&self) -> Option<i64>

pub fn property(&self) -> Option<(GString, SpaPod)>

pub fn rectangle(&self) -> Option<(u32, u32)>

pub fn string(&self) -> Option<GString>

pub fn is_array(&self) -> bool

pub fn is_boolean(&self) -> bool

pub fn is_bytes(&self) -> bool

pub fn is_choice(&self) -> bool

pub fn is_control(&self) -> bool

pub fn is_double(&self) -> bool

pub fn is_fd(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_fraction(&self) -> bool

pub fn is_id(&self) -> bool

pub fn is_int(&self) -> bool

pub fn is_long(&self) -> bool

pub fn is_none(&self) -> bool

pub fn is_object(&self) -> bool

pub fn is_pointer(&self) -> bool

pub fn is_property(&self) -> bool

pub fn is_rectangle(&self) -> bool

pub fn is_sequence(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_struct(&self) -> bool

pub fn is_unique_owner(&self) -> bool

pub fn set_boolean(&self, value: bool) -> bool

pub fn set_double(&self, value: f64) -> bool

pub fn set_fd(&self, value: i64) -> bool

pub fn set_float(&self, value: f32) -> bool

pub fn set_fraction(&self, num: u32, denom: u32) -> bool

pub fn set_id(&self, value: u32) -> bool

pub fn set_int(&self, value: i32) -> bool

pub fn set_long(&self, value: i64) -> bool

pub fn set_pod(&self, pod: &SpaPod) -> bool

pub fn set_rectangle(&self, width: u32, height: u32) -> bool

impl SpaPod

pub fn spa_id(&self) -> Option<Id>

Available on crate feature libspa only.

pub fn spa_fd(&self) -> Option<Fd>

Available on crate feature libspa only.

pub fn deserialize<'de, P: PodDeserialize<'de>>( &'de self ) -> Result<P, DeserializeError<&'de [u8]>>

Available on crate feature libspa only.

pub fn serialize<P: PodSerialize>(value: &P) -> Result<Self, GenError>

Available on crate feature libspa only.

pub fn to_pod_value(&self) -> Result<Value, Error>

Available on crate feature libspa only.

pub fn debug(&self) -> DebugValue<'static, 'static>

impl SpaPod

pub unsafe fn with_pod_unchecked(bytes: &[u8]) -> Self

Safety

Does not tie lifetime of bytes to Self, so requires caller guarantee

pub unsafe fn with_pod_mut_unchecked(bytes: &mut [u8]) -> Self

Safety

Does not tie lifetime of bytes to Self, so requires caller guarantee

pub fn with_copy(pod: &SpaPod) -> Self

pub fn with_pod(bytes: &[u8]) -> Self

pub unsafe fn as_bytes(&self) -> &[u8]

pub fn to_bytes(&self) -> Vec<u8>

pub unsafe fn new_wrap_raw_mut(pod: *mut spa_pod) -> SpaPod

borrows pod for the lifetime of the returned object

pub unsafe fn new_wrap_raw_const(pod: *const spa_pod) -> SpaPod

borrows pod for the lifetime of the returned object

pub fn new_bytes(value: &[u8]) -> SpaPod

pub fn new_pointer(type_name: &str, value: gconstpointer) -> SpaPod

pub fn spa_type(&self) -> Option<SpaType>

pub fn bytes(&self) -> Option<&[u8]>

pub fn choice_type(&self) -> Option<SpaIdValue>

pub fn pointer(&self) -> Option<gconstpointer>

pub fn set_pointer(&self, type_name: &str, value: gconstpointer) -> bool

pub fn iterator(&self) -> IntoValueIterator<SpaPod>

pub fn array_pointers(&self) -> IntoValueIterator<Pointer>

pub fn array_iterator<T: SpaPrimitive>(&self) -> impl Iterator<Item = T>

pub fn spa_pod_raw(&self) -> &spa_pod

pub fn spa_rectangle(&self) -> Option<spa_rectangle>

pub fn spa_fraction(&self) -> Option<spa_fraction>

pub fn struct_fields( &self, length_prefix: bool ) -> Result<IntoIter<(String, SpaPod)>>

Available on crate feature experimental only.

pub fn spa_properties( &self ) -> impl Iterator<Item = (Result<SpaIdValue, WpSpaType>, SpaPod)>

pub fn find_spa_property<K: SpaPropertyKey>(&self, key: &K) -> Option<SpaPod>

pub fn spa_property<T, K: SpaPropertyKey>(&self, key: &K) -> Option<T>

where for<'a> &'a SpaPod: TryInto<T>, for<'a> <&'a SpaPod as TryInto<T>>::Error: Debug,

pub fn set_spa_property<K: SpaPropertyKey>( &self, key: &K, value: &SpaPod ) -> Option<SpaPod>

pub fn apply<O: IsA<PipewireObject>>(self, obj: &O) -> Result<()>

Available on crate feature experimental only.

Trait Implementations

impl Clone for SpaPod

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for SpaPod

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

Formats the value using the given formatter.

impl From<SpaPod> for Value

fn from(s: SpaPod) -> Self

Converts to this type from the input type.

impl<T: SpaValue> FromIterator<T> for SpaPod

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl HasParamSpec for SpaPod

type ParamSpec = ParamSpecBoxed

type SetValue = SpaPod

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, SpaPod>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SpaPod

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SpaPod

fn cmp(&self, other: &SpaPod) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SpaPod

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SpaPod

fn partial_cmp(&self, other: &SpaPod) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SpaValue for SpaPod

fn add_to_builder(&self, builder: &SpaPodBuilder)

type Owned = SpaPod

impl StaticType for SpaPod

fn static_type() -> Type

Returns the type identifier of Self.

impl<'a> TryFrom<&'a SpaPod> for ()

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for Fd

Available on crate feature libspa only.

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for GString

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for Id

Available on crate feature libspa only.

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for SpaBool

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for SpaPod

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for String

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for Value

Available on crate feature libspa only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T: for<'f> TryFrom<&'f SpaPod>> TryFrom<&'a SpaPod> for Vec<T>

where for<'f> <T as TryFrom<&'f SpaPod>>::Error: Into<GlibNoneError>,

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for Vec<u8>

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for bool

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for f32

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for f64

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for i32

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for i64

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for spa_fraction

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for spa_rectangle

type Error = GlibNoneError

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for u32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a SpaPod> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pod: &'a SpaPod) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<Value> for SpaPod

Available on crate feature libspa only.

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Value, Error>

Performs the conversion.

impl Eq for SpaPod