Struct HKCDADocumentSample

Source

pub struct HKCDADocumentSample { /* private fields */ }

Available on crate features HKCDADocumentSample and HKDocumentSample and HKObject and HKSample only.

Expand description

A sample object representing a CDA document.

Implementations§

Source §

impl HKCDADocumentSample

Source

pub unsafe fn document(&self) -> Option<Retained<HKCDADocument>>

The contents of the document.

Access to each CDA instance must be authorized by the user in order for the document data to be accessible to an app. The authorization request occurs the first time a document matches the predicate of an executed HKDocumentQuery. This property will always be nil if the sample is returned by an HKSampleQuery or an HKAnchoredObjectQuery.

Source

pub unsafe fn CDADocumentSampleWithData_startDate_endDate_metadata_validationError( document_data: &NSData, start_date: &NSDate, end_date: &NSDate, metadata: Option<&NSDictionary<NSString, AnyObject>>, ) -> Result<Retained<Self>, Retained<NSError>>

Creates a new document sample with the specified attributes.

Parameter documentData: Document contents in an XML format that meets the CDA standard.

Parameter startDate: The start date for the document.

Parameter endDate: The end date for the document.

Parameter metadata: Metadata for the document.

Parameter validationError: The XML content will be validated against the standard for CDA content. If that validation fails, then this parameter will be set with the relavant error. Detailed information about the failure may be obtained by examining the value for the HKDetailedCDAValidationErrorKey key of the NSError’s userInfo dictionary.

Returns: The new instance or nil if the documentData does not pass validation.

Attributes of the document, such as title, patient name, etc. will be extracted automatically from the document content.

§Safety

metadata generic should be of the correct type.

Source §

impl HKCDADocumentSample

Methods declared on superclass HKObject.

Source

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

Source §

impl HKCDADocumentSample

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = HKDocumentSample>§

Source

pub unsafe fn documentType(&self) -> Retained<HKDocumentType>

Available on crate feature HKObjectType only.

Methods from Deref<Target = HKSample>§

Source

pub unsafe fn sampleType(&self) -> Retained<HKSampleType>

Available on crate feature HKObjectType only.

Source

pub unsafe fn startDate(&self) -> Retained<NSDate>

Source

pub unsafe fn endDate(&self) -> Retained<NSDate>

Source

pub unsafe fn hasUndeterminedDuration(&self) -> bool

Indicates whether a sample has an undetermined duration.

Computed based on the endDate of a sample.

Methods from Deref<Target = HKObject>§

Source

pub unsafe fn UUID(&self) -> Retained<NSUUID>

A unique identifier of the receiver in the HealthKit database.

Source

pub unsafe fn source(&self) -> Retained<HKSource>

👎Deprecated

Available on crate feature HKSource only.

Source

pub unsafe fn sourceRevision(&self) -> Retained<HKSourceRevision>

Available on crate feature HKSourceRevision only.

Represents the revision of the source responsible for saving the receiver.

Source

pub unsafe fn device(&self) -> Option<Retained<HKDevice>>

Available on crate feature HKDevice only.

Represents the device that generated the data of the receiver.

Source

pub unsafe fn metadata( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>

Extra information describing properties of the receiver.

Keys must be NSString and values must be either NSString, NSNumber, NSDate, or HKQuantity. See HKMetadata.h for potential metadata keys and values.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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

👎Deprecated: this is difficult to use correctly, use 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.

Source

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`
    }
}