Struct UIWritingToolsCoordinatorState

#[repr(transparent)]
pub struct UIWritingToolsCoordinatorState(pub NSInteger);

Available on crate feature UIWritingToolsCoordinator only.

The states that indicate the current activity, if any, Writing Tools is performing in your view.

Making changes to your view requires several different levels of interaction. Initially, Writing Tools displays its UI and collects information about what the person wants to do. When the person selects an operation, Writing Tools sends the relevant details to a large language model (LLM) and processes the results. It then works with the custom view to integrate any changes into the view’s text storage. During each of these activities, the coordinator reflects what’s happening in its UIWritingToolsCoordinator/state property. You can use the current state as a guide to making decisions in other parts of your view.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl UIWritingToolsCoordinatorState

pub const Inactive: Self

A state that indicates Writing Tools isn’t currently performing any work on your view’s content.

The coordinator starts in the inactive state, and transitions immediately to the noninteractive or interactiveResting state when someone chooses an option from the Writing Tools UI. After the coordinator finishes incorporating any changes for the current operation, it returns to the inactive state and waits for the person to choose a different option or dismiss the Writing Tools UI.

pub const Noninteractive: Self

A state that indicates Writing Tools is handling interactions in the system UI, instead of in your view.

Writing Tools transitions to this state when the coordinator uses the UIWritingToolsBehavior/limited experience or when someone chooses an option that displays its results in the Writing Tools UI. When the person accepts the changes from the tool or dismisses the Writing Tools UI, the coordinator returns to the inactive state. If the person discards the change and selects a tool with an interactive experience instead, the coordinator transitions to the interactiveResting state.

pub const InteractiveResting: Self

A state that indicates Writing Tools is in the resting state for an inline editing experience.

When someone initially selects a tool with an interactive experience, the coordinator transitions briefly to this state and starts the operation. The coordinator transitions swiftly to the interactiveStreaming state when it submits the request and delivers the results to your view. When it finishes delivering the results, it transitions back to the interactiveResting state and awaits further commands. If the person accepts the changes or dismisses the Writing Tools UI, the coordinator transitions from this state to the inactive state.

pub const InteractiveStreaming: Self

A state that indicates Writing Tools is processing a request and incorporating changes interactively into your view.

The coordinator transitions swiftly from the interactiveResting state to this state at the start of an operation. In this state, the coordinator submits the request for processing and delivers the results back to your view. When the coordinator finishes delivering the results, it transitions back to the interactiveResting state.

Trait Implementations

impl Clone for UIWritingToolsCoordinatorState

fn clone(&self) -> UIWritingToolsCoordinatorState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UIWritingToolsCoordinatorState

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

Formats the value using the given formatter.

impl Encode for UIWritingToolsCoordinatorState

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for UIWritingToolsCoordinatorState

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 Ord for UIWritingToolsCoordinatorState

fn cmp(&self, other: &UIWritingToolsCoordinatorState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UIWritingToolsCoordinatorState

fn eq(&self, other: &UIWritingToolsCoordinatorState) -> 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 PartialOrd for UIWritingToolsCoordinatorState

fn partial_cmp( &self, other: &UIWritingToolsCoordinatorState, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for UIWritingToolsCoordinatorState

const ENCODING_REF: Encoding

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

impl Copy for UIWritingToolsCoordinatorState

impl Eq for UIWritingToolsCoordinatorState

impl StructuralPartialEq for UIWritingToolsCoordinatorState