Struct reaper_medium::ReaperString

pub struct ReaperString(_);

An owned string created by REAPER.

This is is essentially a CString with UTF-8 guarantee.

Design

This type is used primarily in return positions of reaper-rs functions. It wraps a CString because REAPER creates C strings. The benefit over just returning CString is that this type provides convenience methods for converting to Rust strings directly. Whereas arbitrary CStrings can have all kinds of encodings, we know that REAPER uses UTF-8, so this type can be optimistic and converts without returning a Result.

Implementations

impl ReaperString

pub unsafe fn new_unchecked(inner: CString) -> ReaperString

Creates a REAPER string wrapping the given CString.

Safety

You must ensure that the given CString is encoded in UTF-8.

pub fn into_inner(self) -> CString

Consumes this value and spits out the contained C string.

pub fn as_reaper_str(&self) -> &ReaperStr

Converts to a slice.

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.

pub fn into_string(self) -> String

Consumes this value and converts it to an owned Rust string.

Panics

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

Methods from Deref<Target = ReaperStr>

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 Clone for ReaperString

fn clone(&self) -> ReaperString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReaperString

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

Formats the value using the given formatter.

impl Default for ReaperString

fn default() -> ReaperString

Returns the “default value” for a type.

impl Deref for ReaperString

type Target = ReaperStr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ReaperString

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

Formats the value using the given formatter.

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

fn from(value: ReaperString) -> Self

Converts to this type from the input type.

impl From<ReaperString> for ReaperStringArg<'static>

fn from(s: ReaperString) -> Self

Converts to this type from the input type.

impl Hash for ReaperString

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for ReaperString

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

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ReaperString> for ReaperString

fn eq(&self, other: &ReaperString) -> 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<ReaperString> for ReaperString

fn partial_cmp(&self, other: &ReaperString) -> 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 Eq for ReaperString

impl StructuralEq for ReaperString

impl StructuralPartialEq for ReaperString