#[repr(C)]pub struct EKRecurrenceDayOfWeek { /* private fields */ }
EKRecurrenceDayOfWeek
only.Expand description
Class which represents a day of the week this recurrence will occur.
EKRecurrenceDayOfWeek specifies either a simple day of the week, or the nth instance of a particular day of the week, such as the third Tuesday of every month. The week number is only valid when used with monthly or yearly recurrences, since it would be otherwise meaningless.
Valid values for dayOfTheWeek are integers 1-7, which correspond to days of the week with Sunday = 1. Valid values for weekNumber portion are (+/-)1-53, where a negative value indicates a value from the end of the range. For example, in a yearly event -1 means last week of the year. -1 in a Monthly recurrence indicates the last week of the month.
The value 0 also indicates the weekNumber is irrelevant (every Sunday, etc.).
Day-of-week weekNumber values that are out of bounds for the recurrence type will result in an exception when trying to initialize the recurrence. In particular, weekNumber must be zero when passing EKRecurrenceDayOfWeek objects to initialize a weekly recurrence.
See also Apple’s documentation
Implementations§
Source§impl EKRecurrenceDayOfWeek
impl EKRecurrenceDayOfWeek
Sourcepub unsafe fn dayOfWeek(day_of_the_week: EKWeekday) -> Retained<Self>
Available on crate feature EKTypes
only.
pub unsafe fn dayOfWeek(day_of_the_week: EKWeekday) -> Retained<Self>
EKTypes
only.Creates an autoreleased object with a day of the week and week number of zero.
Sourcepub unsafe fn dayOfWeek_weekNumber(
day_of_the_week: EKWeekday,
week_number: NSInteger,
) -> Retained<Self>
Available on crate feature EKTypes
only.
pub unsafe fn dayOfWeek_weekNumber( day_of_the_week: EKWeekday, week_number: NSInteger, ) -> Retained<Self>
EKTypes
only.Creates an autoreleased object with a specific day of week and week number.
Sourcepub unsafe fn initWithDayOfTheWeek_weekNumber(
this: Allocated<Self>,
day_of_the_week: EKWeekday,
week_number: NSInteger,
) -> Retained<Self>
Available on crate feature EKTypes
only.
pub unsafe fn initWithDayOfTheWeek_weekNumber( this: Allocated<Self>, day_of_the_week: EKWeekday, week_number: NSInteger, ) -> Retained<Self>
EKTypes
only.Creates an day-of-week object with a specific day of week and week number.
Sourcepub unsafe fn dayOfTheWeek(&self) -> EKWeekday
Available on crate feature EKTypes
only.
pub unsafe fn dayOfTheWeek(&self) -> EKWeekday
EKTypes
only.The day of the week.
Sourcepub unsafe fn weekNumber(&self) -> NSInteger
pub unsafe fn weekNumber(&self) -> NSInteger
The week number.
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 EKRecurrenceDayOfWeek
impl AsRef<AnyObject> for EKRecurrenceDayOfWeek
Source§impl AsRef<NSObject> for EKRecurrenceDayOfWeek
impl AsRef<NSObject> for EKRecurrenceDayOfWeek
Source§impl Borrow<AnyObject> for EKRecurrenceDayOfWeek
impl Borrow<AnyObject> for EKRecurrenceDayOfWeek
Source§impl Borrow<NSObject> for EKRecurrenceDayOfWeek
impl Borrow<NSObject> for EKRecurrenceDayOfWeek
Source§impl ClassType for EKRecurrenceDayOfWeek
impl ClassType for EKRecurrenceDayOfWeek
Source§const NAME: &'static str = "EKRecurrenceDayOfWeek"
const NAME: &'static str = "EKRecurrenceDayOfWeek"
Source§type ThreadKind = <<EKRecurrenceDayOfWeek as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<EKRecurrenceDayOfWeek as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for EKRecurrenceDayOfWeek
impl CopyingHelper for EKRecurrenceDayOfWeek
Source§type Result = EKRecurrenceDayOfWeek
type Result = EKRecurrenceDayOfWeek
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for EKRecurrenceDayOfWeek
impl Debug for EKRecurrenceDayOfWeek
Source§impl Deref for EKRecurrenceDayOfWeek
impl Deref for EKRecurrenceDayOfWeek
Source§impl Hash for EKRecurrenceDayOfWeek
impl Hash for EKRecurrenceDayOfWeek
Source§impl Message for EKRecurrenceDayOfWeek
impl Message for EKRecurrenceDayOfWeek
Source§impl NSCoding for EKRecurrenceDayOfWeek
impl NSCoding for EKRecurrenceDayOfWeek
Source§impl NSCopying for EKRecurrenceDayOfWeek
impl NSCopying for EKRecurrenceDayOfWeek
Source§impl NSObjectProtocol for EKRecurrenceDayOfWeek
impl NSObjectProtocol for EKRecurrenceDayOfWeek
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