Struct objc2_foundation::NSString

#[repr(C)]
pub struct NSString { /* private fields */ }

A static, plain-text Unicode string object.

See Apple’s documentation.

Implementations

impl NSString

pub fn class() -> &'static Class

impl NSString

pub fn new() -> Id<Self, Shared>

Construct an empty NSString.

pub fn len(&self) -> usize

The number of UTF-8 code units in self.

pub fn is_empty(&self) -> bool

pub fn as_str<'r, 's: 'r, 'p: 'r>(
    &'s self,
    pool: &'p AutoreleasePool
) -> &'r str

Get the str representation of this.

TODO: Further explain this.

pub fn from_str(string: &str) -> Id<Self, Shared>

Creates an immutable NSString by copying the given string slice.

pub fn has_prefix(&self, prefix: &NSString) -> bool

Whether the given string matches the beginning characters of this string.

See Apple’s documentation.

pub fn has_suffix(&self, suffix: &NSString) -> bool

Whether the given string matches the ending characters of this string.

See Apple’s documentation.

Methods from Deref<Target = NSObject>

pub fn hash_code(&self) -> usize

pub fn is_equal(&self, other: &NSObject) -> bool

pub fn description(&self) -> Id<NSString, Shared>

pub fn is_kind_of(&self, cls: &Class) -> bool

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

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

Returns a shared reference to the ivar with the given name.

Panics

Panics if the object has no ivar with the given name, or the type encoding of the ivar differs from the type encoding of T.

Safety

The caller must ensure that the ivar is actually of type T.

Library implementors should expose a safe interface to the ivar.

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

👎 Deprecated:

Use Object::ivar instead.

Use ivar instead.

Safety

Same as ivar.

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

Returns a mutable reference to the ivar with the given name.

Panics

Panics if the object has no ivar with the given name, or the type encoding of the ivar differs from the type encoding of T.

Safety

The caller must ensure that the ivar is actually of type T.

Library implementors should expose a safe interface to the ivar.

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

👎 Deprecated:

Use Object::ivar_mut instead.

Use ivar_mut instead.

Safety

Same as ivar_mut.

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

Sets the value of the ivar with the given name.

Panics

Panics if the object has no ivar with the given name, or the type encoding of the ivar differs from the type encoding of T.

Safety

The caller must ensure that the ivar is actually of type T.

Library implementors should expose a safe interface to the ivar.

Trait Implementations

impl AddAssign<&'_ NSString> for NSMutableString

fn add_assign(&mut self, other: &NSString)

Performs the += operation.

impl AsMut<NSObject> for NSString

fn as_mut(&mut self) -> &mut NSObject

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSString> for NSMutableString

fn as_mut(&mut self) -> &mut NSString

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSString> for NSString

fn as_mut(&mut self) -> &mut Self

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Object> for NSString

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSString

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSString> for NSMutableString

fn as_ref(&self) -> &NSString

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSString> for NSString

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Object> for NSString

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<NSObject> for NSString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSString> for NSMutableString

fn borrow(&self) -> &NSString

Immutably borrows from an owned value.

impl Borrow<Object> for NSString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl BorrowMut<NSObject> for NSString

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl BorrowMut<NSString> for NSMutableString

fn borrow_mut(&mut self) -> &mut NSString

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSString

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

Mutably borrows from an owned value.

impl Debug for NSString

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

Formats the value using the given formatter.

impl DefaultId for NSString

type Ownership = Shared

Indicates whether the default value is mutable or immutable.

fn default_id() -> Id<Self, Self::Ownership>

The default Id for a type.

impl Deref for NSString

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSString

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for NSString

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

Formats the value using the given formatter.

impl Hash for NSString

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 NSCopying for NSString

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSString

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

impl NSMutableCopying for NSString

type Output = NSMutableString

TODO

fn mutable_copy(&self) -> Id<Self::Output, Owned>

impl Ord for NSString

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<NSMutableString> for NSString

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

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

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

This method tests for !=.

impl PartialEq<NSString> for NSMutableString

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

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

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

This method tests for !=.

impl PartialEq<NSString> for NSString

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

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

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

This method tests for !=.

impl PartialOrd<NSMutableString> for NSString

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

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

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

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

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

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

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

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

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 PartialOrd<NSString> for NSMutableString

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

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

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

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

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

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

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

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

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 PartialOrd<NSString> for NSString

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

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

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

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

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

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

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

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

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 RefEncode for NSString

const ENCODING_REF: Encoding<'static> = ::objc2::Encoding::Object

The Objective-C type-encoding for a reference of this type.

impl ToOwned for NSString

type Owned = Id<NSString, Shared>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

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 NSString

impl Message for NSString

impl Send for NSString

impl Sync for NSString