Struct UIShape

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

Available on crate feature UIShape only.

An abstract representation of a shape.

A UIShape can represent a simple shape such as a rectangle or circle that are later “resolved” into a concrete shape based on context like a size and position for the shape. A UIShape can also represent more complex shapes like paths and even “dynamic” shapes that are resolved using a custom closure.

You typically use a UIShape with APIs like UIHoverStyle to represent the shape of an effect.

See also Apple’s documentation

Implementations

impl UIShape

pub unsafe fn rectShape() -> Retained<UIShape>

A rectangular shape.

pub unsafe fn capsuleShape() -> Retained<UIShape>

A capsule shape, equivalent to a rounded rectangle where the corner radius is chosen as half the length of the rectangle’s smallest edge.

pub unsafe fn circleShape() -> Retained<UIShape>

A circular shape, with a radius equals half the length of the frame rectangle’s smallest edge.

pub unsafe fn rectShapeWithCornerRadius( corner_radius: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A rectangular shape with rounded corners, aligned inside the frame of in which it is contained.

pub unsafe fn rectShapeWithCornerRadius_cornerCurve( corner_radius: CGFloat, corner_curve: UICornerCurve, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A rectangular shape with rounded corners, aligned inside the frame of in which it is contained.

pub unsafe fn rectShapeWithCornerRadius_cornerCurve_maskedCorners( corner_radius: CGFloat, corner_curve: UICornerCurve, masked_corners: UIRectCorner, ) -> Retained<Self>

Available on crate features UIGeometry and objc2-core-foundation only.

A rectangular shape with rounded corners, aligned inside the frame of in which it is contained.

pub unsafe fn fixedRectShapeWithRect(rect: CGRect) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A fixed rectangle shape using rect as its shape, regardless of the frame in which it is contained.

pub unsafe fn fixedRectShapeWithRect_cornerRadius( rect: CGRect, corner_radius: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

A fixed rectangle shape using rect as its shape, regardless of the frame in which it is contained, with rounded corners using cornerRadius.

pub unsafe fn fixedRectShapeWithRect_cornerRadius_cornerCurve_maskedCorners( rect: CGRect, corner_radius: CGFloat, corner_curve: UICornerCurve, masked_corners: UIRectCorner, ) -> Retained<Self>

Available on crate features UIGeometry and objc2-core-foundation only.

A fixed rectangle shape using rect as its shape, regardless of the frame in which it is contained, with rounded corners using cornerRadius.

pub unsafe fn shapeWithBezierPath(path: &UIBezierPath) -> Retained<Self>

Available on crate feature UIBezierPath only.

A shape with a custom bezier path.

pub unsafe fn shapeWithProvider( provider: &ProtocolObject<dyn UIShapeProvider>, ) -> Retained<Self>

Creates a dynamic shape that can be resolved using the provided UIShapeProvider based on context like its containing rect.

pub unsafe fn shapeByApplyingInsets( &self, insets: UIEdgeInsets, ) -> Retained<UIShape>

Available on crate features UIGeometry and objc2-core-foundation only.

Insets this shape by the provided insets, returning a new modified shape.

Negative values can be used to add inner padding to a shape. If this shape is not insettable (e.g., if it is a custom path), this has no effect. For some shapes like rounded rectangles, this can also modify the corner radii of the shape to ensure the resulting corners are concentric.

pub unsafe fn shapeByApplyingInset(&self, inset: CGFloat) -> Retained<UIShape>

Available on crate feature objc2-core-foundation only.

Insets this shape by the provided inset, returning a new modified shape.

Negative values can be used to add inner padding to a shape. If this shape is not insettable (e.g., if it is a custom path), this has no effect. For some shapes like rounded rectangles, this can also modify the corner radii of the shape to ensure the resulting corners are concentric.

pub unsafe fn resolvedShapeInContext( &self, context: &UIShapeResolutionContext, ) -> Retained<UIResolvedShape>

Resolves this shape in the provided context.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Available on crate feature UIIndirectScribbleInteraction only.

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature UIIndirectScribbleInteraction only.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Available on crate feature UIIndirectScribbleInteraction only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for UIShape

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIShape

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIShape> for UIShape

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIShape

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIShape

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIShape

const NAME: &'static str = "UIShape"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<UIShape as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for UIShape

type Result = UIShape

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for UIShape

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

Formats the value using the given formatter.

impl Deref for UIShape

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIShape

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for UIShape

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for UIShape

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for UIShape

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for UIShape

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for UIShape

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl UIShapeProvider for UIShape

unsafe fn resolvedShapeInContext( &self, context: &UIShapeResolutionContext, ) -> Retained<UIResolvedShape>

where Self: Sized + Message,

Resolves this shape in the provided context.

impl DowncastTarget for UIShape

impl Eq for UIShape