Struct objc2_foundation::NSString
source · [−]#[repr(C)]pub struct NSString { /* private fields */ }
Expand description
A static, plain-text Unicode string object.
Implementations
sourceimpl NSString
impl NSString
pub fn is_empty(&self) -> bool
sourcepub fn as_str<'r, 's: 'r, 'p: 'r>(&'s self, pool: &'p AutoreleasePool) -> &'r str
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.
sourcepub fn from_str(string: &str) -> Id<Self, Shared>
pub fn from_str(string: &str) -> Id<Self, Shared>
Creates an immutable NSString
by copying the given string slice.
sourcepub fn has_prefix(&self, prefix: &NSString) -> bool
pub fn has_prefix(&self, prefix: &NSString) -> bool
Whether the given string matches the beginning characters of this string.
sourcepub fn has_suffix(&self, suffix: &NSString) -> bool
pub fn has_suffix(&self, suffix: &NSString) -> bool
Whether the given string matches the ending characters of this string.
Methods from Deref<Target = NSObject>
Methods from Deref<Target = Object>
sourcepub unsafe fn ivar_ptr<T>(&self, name: &str) -> *mut T where
T: Encode,
pub unsafe fn ivar_ptr<T>(&self, name: &str) -> *mut T where
T: Encode,
Returns a pointer to the instance variable / ivar with the given name.
This is similar to [UnsafeCell::get
], see that for more information
on what is and isn’t safe to do.
Usually you will have defined the instance variable yourself with
ClassBuilder::add_ivar
, the type of the ivar T
must match the
type used in that.
Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.
Library implementors are strongly encouraged to expose a safe interface to the ivar.
Panics
May panic if the object has no ivar with the given name. May also
panic if the type encoding of the ivar differs from the type encoding
of T
.
This should purely seen as help while debugging and is not guaranteed
(e.g. it may be disabled when debug_assertions
are off).
Safety
The object must have an instance variable with the given name, and it
must be of type T
. Any invariants that the object have assumed about
the value of the instance variable must not be violated.
No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.
sourcepub unsafe fn ivar<T>(&self, name: &str) -> &T where
T: Encode,
pub unsafe fn ivar<T>(&self, name: &str) -> &T where
T: Encode,
Returns a reference to the instance variable with the given name.
See Object::ivar_ptr
for more information, including on when this
panics.
Safety
The object must have an instance variable with the given name, and it
must be of type T
.
No thread syncronization is done, so you must ensure that no other
thread is concurrently mutating the variable. This requirement can be
considered upheld if all mutation happens through Object::ivar_mut
(since that takes &mut self
).
sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &T where
T: Encode,
👎 Deprecated: Use Object::ivar
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &T where
T: Encode,
Use Object::ivar
instead.
sourcepub unsafe fn ivar_mut<T>(&mut self, name: &str) -> &mut T where
T: Encode,
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.
See Object::ivar_ptr
for more information, including on when this
panics.
Safety
The object must have an instance variable with the given name, and it
must be of type T
.
This access happens through &mut self
, which means we know it to be
the only reference, hence you do not need to do any work to ensure
that data races do not happen.
sourcepub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T where
T: Encode,
👎 Deprecated: Use Object::ivar_mut
instead.
pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T where
T: Encode,
Use Object::ivar_mut
instead.
sourcepub unsafe fn set_ivar<T>(&mut self, name: &str, value: T) where
T: Encode,
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.
This is just a helpful shorthand for Object::ivar_mut
, see that
for more information.
Safety
Same as Object::ivar_mut
.
Trait Implementations
sourceimpl AddAssign<&NSString> for NSMutableString
impl AddAssign<&NSString> for NSMutableString
sourcefn add_assign(&mut self, other: &NSString)
fn add_assign(&mut self, other: &NSString)
Performs the +=
operation. Read more
sourceimpl AsMut<NSString> for NSMutableString
impl AsMut<NSString> for NSMutableString
sourceimpl AsRef<NSString> for NSMutableString
impl AsRef<NSString> for NSMutableString
sourceimpl Borrow<NSString> for NSMutableString
impl Borrow<NSString> for NSMutableString
sourceimpl BorrowMut<NSObject> for NSString
impl BorrowMut<NSObject> for NSString
sourcefn borrow_mut(&mut self) -> &mut NSObject
fn borrow_mut(&mut self) -> &mut NSObject
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<NSString> for NSMutableString
impl BorrowMut<NSString> for NSMutableString
sourcefn borrow_mut(&mut self) -> &mut NSString
fn borrow_mut(&mut self) -> &mut NSString
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSString
impl BorrowMut<Object> for NSString
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl NSMutableCopying for NSString
impl NSMutableCopying for NSString
type Output = NSMutableString
type Output = NSMutableString
TODO
fn mutable_copy(&self) -> Id<Self::Output, Owned>
sourceimpl Ord for NSString
impl Ord for NSString
sourceimpl PartialEq<NSMutableString> for NSString
impl PartialEq<NSMutableString> for NSString
sourceimpl PartialEq<NSString> for NSMutableString
impl PartialEq<NSString> for NSMutableString
sourceimpl PartialOrd<NSMutableString> for NSString
impl PartialOrd<NSMutableString> for NSString
sourcefn partial_cmp(&self, other: &NSMutableString) -> Option<Ordering>
fn partial_cmp(&self, other: &NSMutableString) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl PartialOrd<NSString> for NSMutableString
impl PartialOrd<NSString> for NSMutableString
sourcefn partial_cmp(&self, other: &NSString) -> Option<Ordering>
fn partial_cmp(&self, other: &NSString) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl PartialOrd<NSString> for NSString
impl PartialOrd<NSString> for NSString
sourcefn partial_cmp(&self, other: &Self) -> Option<Ordering>
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl RefEncode for NSString
impl RefEncode for NSString
sourceconst ENCODING_REF: Encoding<'static> = <NSObject as crate::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding<'static> = <NSObject as crate::objc2::RefEncode>::ENCODING_REF
The Objective-C type-encoding for a reference of this type. Read more
sourceimpl ToOwned for NSString
impl ToOwned for NSString
impl Eq for NSString
impl Message for NSString
impl RefUnwindSafe for NSString
impl Send for NSString
impl StructuralEq for NSString
impl StructuralPartialEq for NSString
impl Sync for NSString
impl UnwindSafe for NSString
Auto Trait Implementations
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more