Struct OwnedString 

pub struct OwnedString { /* private fields */ }

Rust-side ownership of an ABI string and its producer’s deallocator. Not Copy or Clone: moving the value transfers cleanup responsibility.

use rpi_plugin_sdk::callbacks::OwnedString;
let owner = OwnedString::from_string("text".into());
let copy = owner;
drop(owner); // Ownership moved; a second release cannot be expressed safely.

Implementations

impl OwnedString

pub fn from_string(text: String) -> Self

pub unsafe fn from_raw(raw: StbString, free: Option<FreeStringFn>) -> Self

Adopt an owning string at an ABI boundary.

Safety

The caller transfers unique ownership of a live buffer satisfying StbString::to_string_lossy’s requirements. No raw copy may subsequently be read, changed or freed while this owner exists. free, when present, must be this buffer’s producer-side deallocator, callable from any thread. When absent, the allocation will not be reclaimed automatically.

pub fn to_string_lossy(&self) -> String

pub fn as_str_lossy(&self) -> Cow<'_, str>

Read the buffer without copying valid UTF-8. Invalid UTF-8 is replaced, matching Self::to_string_lossy. The view cannot outlive its owner.

use rpi_plugin_sdk::callbacks::OwnedString;
let text = {
    let owner = OwnedString::from_string("text".into());
    owner.as_str_lossy()
};
println!("{text}");

pub fn into_raw(self) -> StbString

Transfer ownership back across the ABI, without freeing the buffer. The receiver must use the same producer’s deallocator exactly once.

Trait Implementations

impl Drop for OwnedString

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.