#[repr(C)]pub struct EKRecurrenceEnd { /* private fields */ }
EKRecurrenceEnd
only.Expand description
Class which represents when a recurrence should end.
EKRecurrenceEnd is an attribute of EKRecurrenceRule that defines how long the recurrence is scheduled to repeat. The recurrence can be defined either with an NSUInteger that indicates the total number times it repeats, or with an NSDate, after which it no longer repeats. An event which is set to never end should have its EKRecurrenceEnd set to nil.
If the end of the pattern is defines with an NSDate, the client must pass a valid NSDate, nil cannot be passed. If the end of the pattern is defined as terms of a number of occurrences, the occurrenceCount passed to the initializer must be positive, it cannot be 0. If the client attempts to initialize a EKRecurrenceEnd with a nil NSDate or OccurrenceCount of 0, an exception is raised.
A EKRecurrenceEnd initialized with an end date will return 0 for occurrenceCount. One initialized with a number of occurrences will return nil for its endDate.
See also Apple’s documentation
Implementations§
Source§impl EKRecurrenceEnd
impl EKRecurrenceEnd
Sourcepub unsafe fn recurrenceEndWithEndDate(end_date: &NSDate) -> Retained<Self>
pub unsafe fn recurrenceEndWithEndDate(end_date: &NSDate) -> Retained<Self>
Creates an autoreleased recurrence end with a specific end date.
Sourcepub unsafe fn recurrenceEndWithOccurrenceCount(
occurrence_count: NSUInteger,
) -> Retained<Self>
pub unsafe fn recurrenceEndWithOccurrenceCount( occurrence_count: NSUInteger, ) -> Retained<Self>
Creates an autoreleased recurrence end with a maximum occurrence count.
Sourcepub unsafe fn endDate(&self) -> Option<Retained<NSDate>>
pub unsafe fn endDate(&self) -> Option<Retained<NSDate>>
The end date of this recurrence, or nil if it’s count-based.
Sourcepub unsafe fn occurrenceCount(&self) -> NSUInteger
pub unsafe fn occurrenceCount(&self) -> NSUInteger
The maximum occurrence count, or 0 if it’s date-based.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for EKRecurrenceEnd
impl AsRef<AnyObject> for EKRecurrenceEnd
Source§impl AsRef<EKRecurrenceEnd> for EKRecurrenceEnd
impl AsRef<EKRecurrenceEnd> for EKRecurrenceEnd
Source§impl AsRef<NSObject> for EKRecurrenceEnd
impl AsRef<NSObject> for EKRecurrenceEnd
Source§impl Borrow<AnyObject> for EKRecurrenceEnd
impl Borrow<AnyObject> for EKRecurrenceEnd
Source§impl Borrow<NSObject> for EKRecurrenceEnd
impl Borrow<NSObject> for EKRecurrenceEnd
Source§impl ClassType for EKRecurrenceEnd
impl ClassType for EKRecurrenceEnd
Source§const NAME: &'static str = "EKRecurrenceEnd"
const NAME: &'static str = "EKRecurrenceEnd"
Source§type ThreadKind = <<EKRecurrenceEnd as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<EKRecurrenceEnd as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for EKRecurrenceEnd
impl CopyingHelper for EKRecurrenceEnd
Source§type Result = EKRecurrenceEnd
type Result = EKRecurrenceEnd
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for EKRecurrenceEnd
impl Debug for EKRecurrenceEnd
Source§impl Deref for EKRecurrenceEnd
impl Deref for EKRecurrenceEnd
Source§impl Hash for EKRecurrenceEnd
impl Hash for EKRecurrenceEnd
Source§impl Message for EKRecurrenceEnd
impl Message for EKRecurrenceEnd
Source§impl NSCoding for EKRecurrenceEnd
impl NSCoding for EKRecurrenceEnd
Source§impl NSCopying for EKRecurrenceEnd
impl NSCopying for EKRecurrenceEnd
Source§impl NSObjectProtocol for EKRecurrenceEnd
impl NSObjectProtocol for EKRecurrenceEnd
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref