Struct libspa::pod::Pod

pub struct Pod(/* private fields */);

A transparent wrapper around a spa_sys::spa_pod.

Implementations

impl Pod

pub unsafe fn from_raw(pod: *const spa_pod) -> &'static Self

Safety

The provided pointer must point to a valid, well-aligned pod.

The pods allocation must fit the entire size of the pod as indicated by the pods header, including header size, body size and any padding.

The provided pod must not be mutated, moved, freed or similar while the borrow returned from this function is in use. This also means that other nonmutable borrows may be created to this pod, but no mutable borrows to this pod may be created until all borrows are dropped.

The returned type has 'static lifetime. It is suggested to shorten the lifetime to whatever is applicable afterwards.

pub unsafe fn from_raw_mut(pod: *mut spa_pod) -> &'static mut Self

Safety

The provided pointer must point to a valid, well-aligned pod.

The pods allocation must fit the entire size of the pod as indicated by the pods header, including header size, body size and any padding.

The provided pod must not be mutated, moved, freed or similar while the borrow returned from this function is in use. This also means that no other borrow to this pod may be created until the borrow is dropped.

The returned type has 'static lifetime. It is suggested to shorten the lifetime to whatever is applicable afterwards.

pub fn as_raw_ptr(&self) -> *mut spa_pod

pub fn body(&self) -> *mut c_void

Returns a pointer to the pods body.

If the pod has an empty body, this can be outside the pods allocation.

pub fn from_bytes(bytes: &[u8]) -> Option<&Self>

Construct a pod from raw bytes.

The provided slice must be big enough to fit the entire pod including padding.

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

pub fn type_(&self) -> SpaTypes

pub fn size(&self) -> u32

pub fn is_none(&self) -> bool

pub fn is_bool(&self) -> bool

pub fn get_bool(&self) -> Result<bool, Errno>

pub fn is_id(&self) -> bool

pub fn get_id(&self) -> Result<Id, Errno>

pub fn is_int(&self) -> bool

pub fn get_int(&self) -> Result<i32, Errno>

pub fn is_long(&self) -> bool

pub fn get_long(&self) -> Result<i64, Errno>

pub fn is_float(&self) -> bool

pub fn get_float(&self) -> Result<f32, Errno>

pub fn is_double(&self) -> bool

pub fn get_double(&self) -> Result<f64, Errno>

pub fn is_string(&self) -> bool

pub fn is_bytes(&self) -> bool

pub fn get_bytes(&self) -> Result<&[u8], Errno>

pub fn is_pointer(&self) -> bool

pub fn get_pointer(&self) -> Result<(*const c_void, Id), Errno>

pub fn is_fd(&self) -> bool

pub fn get_fd(&self) -> Result<RawFd, Errno>

pub fn is_rectangle(&self) -> bool

pub fn get_rectangle(&self) -> Result<Rectangle, Errno>

pub fn is_fraction(&self) -> bool

pub fn get_fraction(&self) -> Result<Fraction, Errno>

pub fn is_bitmap(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_choice(&self) -> bool

pub fn is_struct(&self) -> bool

pub fn as_struct(&self) -> Result<&PodStruct, Errno>

pub fn is_object(&self) -> bool

pub fn as_object(&self) -> Result<&PodObject, Errno>

pub fn is_sequence(&self) -> bool

Trait Implementations

impl AsRef<Pod> for PodObject

fn as_ref(&self) -> &Pod

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Pod> for PodStruct

fn as_ref(&self) -> &Pod

Converts this type into a shared reference of the (usually inferred) input type.

impl<'p> From<&'p PodObject> for &'p Pod

fn from(value: &'p PodObject) -> Self

Converts to this type from the input type.

impl<'p> From<&'p PodStruct> for &'p Pod

fn from(value: &'p PodStruct) -> Self

Converts to this type from the input type.

impl<'p> TryFrom<&'p Pod> for &'p PodObject

type Error = Errno

The type returned in the event of a conversion error.

fn try_from(value: &'p Pod) -> Result<Self, Self::Error>

Performs the conversion.

impl<'p> TryFrom<&'p Pod> for &'p PodStruct

type Error = Errno

The type returned in the event of a conversion error.

fn try_from(value: &'p Pod) -> Result<Self, Self::Error>

Performs the conversion.