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.

See Apple’s documentation.

Implementations§

source §

impl NSAttributedString

Creating attributed strings.

source

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

Construct an empty attributed string.

source

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.

source

pub fn from_nsstring(string: &NSString) -> Id<Self, Shared>

Creates a new attributed string without any attributes.

source §

impl NSAttributedString

Querying.

source

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

source

pub fn len_utf16(&self) -> usize

Alias for self.string().len_utf16().

Methods from Deref<Target = NSObject>§

source

pub fn is_kind_of<T: ClassType>(&self) -> bool

Check if the object is an instance of the class, or one of it’s subclasses.

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>§

source

pub fn class(&self) -> &Class

Dynamically find the class of this object.

source

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

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.

source

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

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).

source

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

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

source

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

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.

source