Struct SKSummary 

pub struct SKSummary { /* private fields */ }

Available on crate feature SKSummary only.

Apple’s documentation

Implementations

impl SKSummary

pub unsafe fn with_string( in_string: Option<&CFString>, ) -> Option<CFRetained<SKSummary>>

Available on crate feature SearchKit only.

Safety

in_string might not allow None.

pub unsafe fn sentence_count(&self) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn paragraph_count(&self) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn sentence_at_index( &self, i: CFIndex, ) -> Option<CFRetained<CFString>>

Available on crate feature SearchKit only.

pub unsafe fn paragraph_at_index( &self, i: CFIndex, ) -> Option<CFRetained<CFString>>

Available on crate feature SearchKit only.

pub unsafe fn sentence_summary_string( &self, num_sentences: CFIndex, ) -> Option<CFRetained<CFString>>

Available on crate feature SearchKit only.

pub unsafe fn paragraph_summary_string( &self, num_paragraphs: CFIndex, ) -> Option<CFRetained<CFString>>

Available on crate feature SearchKit only.

pub unsafe fn sentence_summary_info( &self, num_sentences_in_summary: CFIndex, out_rank_order_of_sentences: *mut CFIndex, out_sentence_index_of_sentences: *mut CFIndex, out_paragraph_index_of_sentences: *mut CFIndex, ) -> CFIndex

Available on crate feature SearchKit only.

Safety

• out_rank_order_of_sentences must be a valid pointer.
• out_sentence_index_of_sentences must be a valid pointer.
• out_paragraph_index_of_sentences must be a valid pointer.

pub unsafe fn paragraph_summary_info( &self, num_paragraphs_in_summary: CFIndex, out_rank_order_of_paragraphs: *mut CFIndex, out_paragraph_index_of_paragraphs: *mut CFIndex, ) -> CFIndex

Available on crate feature SearchKit only.

Safety

• out_rank_order_of_paragraphs must be a valid pointer.
• out_paragraph_index_of_paragraphs must be a valid pointer.

Methods from Deref<Target = CFType>

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

where T: ConcreteType,

Available on crate features SearchKit and SKDocument only.

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Available on crate features SearchKit and SKDocument only.

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for SKSummary

Available on crate feature SearchKit only.

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for SKSummary

Available on crate feature SearchKit only.

fn as_ref(&self) -> &CFType

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

impl AsRef<SKSummary> for SKSummary

Available on crate feature SearchKit only.

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SKSummary

Available on crate feature SearchKit only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for SKSummary

Available on crate feature SearchKit only.

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for SKSummary

Available on crate feature SearchKit only.

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for SKSummary

Available on crate feature SearchKit only.

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

Formats the value using the given formatter.

impl Deref for SKSummary

Available on crate feature SearchKit only.

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SKSummary

Available on crate feature SearchKit only.

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 SKSummary

Available on crate feature SearchKit only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for SKSummary

Available on crate feature SearchKit only.

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 SKSummary

Available on crate feature SearchKit only.

const ENCODING_REF: Encoding

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

impl Type for SKSummary

Available on crate feature SearchKit only.

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

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for SKSummary

Available on crate feature SearchKit only.