Struct reaper_medium::ReaperStr

pub struct ReaperStr(_);

A borrowed string owned by REAPER.

reaper-rs functions pass this type to consumer-provided closures.

See ReaperString for further details.

Implementations

impl ReaperStr

pub unsafe fn from_ptr<'a>(ptr: *const c_char) -> &'a ReaperStr

Wraps a raw C string with a safe Reaper string wrapper.

Safety

You must ensure that the given pointer refers to a valid UTF-8 encoded C string.

pub fn to_reaper_string(&self) -> ReaperString

Converts a ReaperStr to an owned ReaperString.

pub fn as_c_str(&self) -> &CStr

Yields the underlying &CStr.

pub fn to_str(&self) -> &str

Converts this value to a Rust string slice.

Panics

This function panics if the string is not properly UTF-8 encoded.

Trait Implementations

impl Borrow<ReaperStr> for ReaperString

fn borrow(&self) -> &ReaperStr

Immutably borrows from an owned value.

impl Debug for ReaperStr

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

Formats the value using the given formatter.

impl Default for &ReaperStr

fn default() -> Self

Returns the “default value” for a type.

impl Display for ReaperStr

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

Formats the value using the given formatter.

impl<'a> From<&'a ReaperStr> for Cow<'a, ReaperStr>

fn from(value: &'a ReaperStr) -> Self

Converts to this type from the input type.

impl<'a> From<&'a ReaperStr> for ReaperStringArg<'a>

fn from(s: &'a ReaperStr) -> Self

Converts to this type from the input type.

impl Hash for ReaperStr

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

Feeds this value into the given Hasher.

impl Ord for ReaperStr

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

This method returns an Ordering between self and other.

impl PartialEq<ReaperStr> for ReaperStr

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

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

const 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<ReaperStr> for ReaperStr

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

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

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

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

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

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

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

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

const 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 ToOwned for ReaperStr

type Owned = ReaperString

The resulting type after obtaining ownership.

fn to_owned(&self) -> ReaperString

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for ReaperStr

impl StructuralEq for ReaperStr

impl StructuralPartialEq for ReaperStr