Struct cacao::foundation::NSString

pub struct NSString<'a> {
    pub objc: Id<Object>,
    /* private fields */
}

A wrapper for NSString.

We can make a few safety guarantees in this module as the UTF8 code on the Foundation side is fairly battle tested.

Fields

objc: Id<Object>

A reference to the backing NSString.

Implementations

impl<'a> NSString<'a>

pub fn new(s: &str) -> Self

Creates a new NSString.

pub fn no_copy(s: &'a str) -> Self

Creates a new NSString without copying the bytes for the passed-in string.

pub fn retain(object: id) -> Self

In cases where we’re vended an NSString by the system, this can be used to wrap and retain it.

pub fn from_retained(object: id) -> Self

In some cases, we want to wrap a system-provided NSString without retaining it.

pub fn is(obj: id) -> bool

Utility method for checking whether an NSObject is an NSString.

pub fn to_str(&self) -> &str

A utility method for taking an NSString and bridging it to a Rust &str.

pub fn to_string(&self) -> String

A utility method for taking an NSString and getting an owned String from it.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T where
    T: Encode, 

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T where
    T: Encode, 

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T) where
    T: Encode, 

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl<'a> Debug for NSString<'a>

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

Formats the value using the given formatter.

impl Deref for NSString<'_>

fn deref(&self) -> &Object

Derefs to the underlying Objective-C Object.

type Target = Object

The resulting type after dereferencing.

impl DerefMut for NSString<'_>

fn deref_mut(&mut self) -> &mut Object

Derefs to the underlying Objective-C Object.

impl Display for NSString<'_>

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

Formats the value using the given formatter.

impl From<NSString<'_>> for SessionRole

Available on crate feature uikit only.

fn from(value: NSString<'_>) -> Self

Converts to this type from the input type.

impl From<NSString<'_>> for id

fn from(string: NSString<'_>) -> Self

Consumes and returns the pointer to the underlying NSString instance.

impl From<NotificationName> for NSString<'_>

fn from(name: NotificationName) -> Self

Converts to this type from the input type.

impl From<PasteboardName> for NSString<'_>

fn from(name: PasteboardName) -> Self

Converts to this type from the input type.

impl From<PasteboardType> for NSString<'_>

fn from(pboard_type: PasteboardType) -> Self

Converts to this type from the input type.

impl From<SessionRole> for NSString<'_>

Available on crate feature uikit only.

fn from(role: SessionRole) -> Self

Converts to this type from the input type.