Struct objc2_foundation::NSAttributedString
source · [−]#[repr(C)]pub struct NSAttributedString { /* private fields */ }
Expand description
A string that has associated attributes for portions of its text.
Examples of attributes could be: Visual style, hyperlinks, or accessibility data.
Conceptually, each UTF-16 code unit in an attributed string has its own collection of attributes - most often though
Only the most basic functionality is defined here, the AppKit
framework contains most of the extension methods.
Implementations
sourceimpl NSAttributedString
impl NSAttributedString
Creating attributed strings.
sourcepub fn new_with_attributes(
string: &NSString,
attributes: &NSDictionary<NSAttributedStringKey, Object>
) -> Id<Self, Shared>
pub fn new_with_attributes(
string: &NSString,
attributes: &NSDictionary<NSAttributedStringKey, Object>
) -> Id<Self, Shared>
Creates a new attributed string from the given string and attributes.
The attributes are associated with every UTF-16 code unit in the string.
sourcepub fn from_nsstring(string: &NSString) -> Id<Self, Shared>
pub fn from_nsstring(string: &NSString) -> Id<Self, Shared>
Creates a new attributed string without any attributes.
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 AsMut<NSAttributedString> for NSAttributedString
impl AsMut<NSAttributedString> for NSAttributedString
sourceimpl AsMut<NSAttributedString> for NSMutableAttributedString
impl AsMut<NSAttributedString> for NSMutableAttributedString
sourcefn as_mut(&mut self) -> &mut NSAttributedString
fn as_mut(&mut self) -> &mut NSAttributedString
Converts this type into a mutable reference of the (usually inferred) input type.
sourceimpl AsMut<NSObject> for NSAttributedString
impl AsMut<NSObject> for NSAttributedString
sourceimpl AsMut<Object> for NSAttributedString
impl AsMut<Object> for NSAttributedString
sourceimpl AsRef<NSAttributedString> for NSAttributedString
impl AsRef<NSAttributedString> for NSAttributedString
sourceimpl AsRef<NSAttributedString> for NSMutableAttributedString
impl AsRef<NSAttributedString> for NSMutableAttributedString
sourcefn as_ref(&self) -> &NSAttributedString
fn as_ref(&self) -> &NSAttributedString
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl AsRef<NSObject> for NSAttributedString
impl AsRef<NSObject> for NSAttributedString
sourceimpl AsRef<Object> for NSAttributedString
impl AsRef<Object> for NSAttributedString
sourceimpl Borrow<NSAttributedString> for NSMutableAttributedString
impl Borrow<NSAttributedString> for NSMutableAttributedString
sourcefn borrow(&self) -> &NSAttributedString
fn borrow(&self) -> &NSAttributedString
Immutably borrows from an owned value. Read more
sourceimpl Borrow<NSObject> for NSAttributedString
impl Borrow<NSObject> for NSAttributedString
sourceimpl Borrow<Object> for NSAttributedString
impl Borrow<Object> for NSAttributedString
sourceimpl BorrowMut<NSAttributedString> for NSMutableAttributedString
impl BorrowMut<NSAttributedString> for NSMutableAttributedString
sourcefn borrow_mut(&mut self) -> &mut NSAttributedString
fn borrow_mut(&mut self) -> &mut NSAttributedString
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<NSObject> for NSAttributedString
impl BorrowMut<NSObject> for NSAttributedString
sourcefn borrow_mut(&mut self) -> &mut NSObject
fn borrow_mut(&mut self) -> &mut NSObject
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSAttributedString
impl BorrowMut<Object> for NSAttributedString
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl Debug for NSAttributedString
impl Debug for NSAttributedString
sourceimpl DefaultId for NSAttributedString
impl DefaultId for NSAttributedString
sourceimpl Deref for NSAttributedString
impl Deref for NSAttributedString
sourceimpl DerefMut for NSAttributedString
impl DerefMut for NSAttributedString
sourceimpl Hash for NSAttributedString
impl Hash for NSAttributedString
sourceimpl NSCopying for NSAttributedString
impl NSCopying for NSAttributedString
sourceimpl NSMutableCopying for NSAttributedString
impl NSMutableCopying for NSAttributedString
type Output = NSMutableAttributedString
type Output = NSMutableAttributedString
TODO
fn mutable_copy(&self) -> Id<Self::Output, Owned>
sourceimpl PartialEq<NSAttributedString> for NSAttributedString
impl PartialEq<NSAttributedString> for NSAttributedString
sourcefn eq(&self, other: &NSAttributedString) -> bool
fn eq(&self, other: &NSAttributedString) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &NSAttributedString) -> bool
fn ne(&self, other: &NSAttributedString) -> bool
This method tests for !=
.
sourceimpl RefEncode for NSAttributedString
impl RefEncode for NSAttributedString
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 NSAttributedString
impl ToOwned for NSAttributedString
type Owned = Id<NSAttributedString, Shared>
type Owned = Id<NSAttributedString, Shared>
The resulting type after obtaining ownership.
sourcefn to_owned(&self) -> Self::Owned
fn to_owned(&self) -> Self::Owned
Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · sourcefn clone_into(&self, target: &mut Self::Owned)
fn clone_into(&self, target: &mut Self::Owned)
Uses borrowed data to replace owned data, usually by cloning. Read more
impl Eq for NSAttributedString
impl Message for NSAttributedString
impl Send for NSAttributedString
impl StructuralEq for NSAttributedString
impl StructuralPartialEq for NSAttributedString
impl Sync for NSAttributedString
Auto Trait Implementations
impl !RefUnwindSafe for NSAttributedString
impl !Unpin for NSAttributedString
impl !UnwindSafe for NSAttributedString
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