pub struct ReaperString(_);
Expand description

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

Creates a REAPER string wrapping the given CString.

Safety

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

Consumes this value and spits out the contained C string.

Converts to a slice.

Converts this value to a Rust string slice.

Panics

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

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>

Converts a ReaperStr to an owned ReaperString.

Yields the underlying &CStr.

Converts this value to a Rust string slice.

Panics

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

Trait Implementations

Immutably borrows from an owned value. Read more
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
The resulting type after dereferencing.
Dereferences the value.
Formats the value using the given formatter. Read more
Converts to this type from the input type.
Converts to this type from the input type.
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more
Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.