Struct UserProperty 

pub struct UserProperty {
    pub name: Utf8CString,
    pub kind: UserPropertyKind,
}

Available on crate feature studio only.

Describes a user property.

Fields

name: Utf8CString

Property name.

kind: UserPropertyKind

Property type.

Implementations

impl UserProperty

pub unsafe fn from_ffi(value: FMOD_STUDIO_USER_PROPERTY) -> Self

Create a safe UserPropertyKind struct from the FFI equivalent.

Safety

All string values from the FFI struct must be a null-terminated and must be valid for reads of bytes up to and including the nul terminator. The type field must match the type assigned to the union.

See Utf8CStr::from_ptr_unchecked for more information.

Panics

This function will panic if value is not a valid user property type.

Trait Implementations

impl Clone for UserProperty

fn clone(&self) -> UserProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserProperty

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

Formats the value using the given formatter.

impl From<&UserProperty> for FMOD_STUDIO_USER_PROPERTY

fn from(value: &UserProperty) -> Self

Converts to this type from the input type.

impl PartialEq for UserProperty

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for UserProperty