Struct Tag

pub struct Tag {
    pub kind: TagType,
    pub name: Utf8CString,
    pub data: TagData,
    pub updated: bool,
}

Tag data / metadata description.

Fields

kind: TagType

Tag type.

name: Utf8CString

Name.

data: TagData

Tag data type.

updated: bool

True if this tag has been updated since last being accessed with Sound::get_tag

Implementations

impl Tag

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

Create a safe Tag struct from the FFI equivalent.

Safety

The string FMOD_TAG::name must be a null-terminated and must be valid for reads of bytes up to and including the nul terminator.

This function will read into arbitrary memory! Because of this the tag data type must match the data type of the data pointer.

Panics

This function will panic if value is not valid (Invalid type, wrong data length, etc)

Trait Implementations

impl Debug for Tag

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

Formats the value using the given formatter.