cranpose_services/
lib.rs

1#![doc = include_str!("../README.md")]
2
3#[cfg(test)]
4use cranpose_core::{Composition, MemoryApplier, location_key};
5
6pub mod accessibility_options;
7pub mod accessibility_state;
8pub mod app_info;
9pub mod app_update;
10pub mod async_io;
11pub mod audio;
12pub mod background;
13pub mod bundled_assets;
14pub mod camera;
15mod composition_locals;
16pub mod content;
17pub mod device_info;
18mod durable_save;
19pub mod file_picker;
20#[cfg(not(target_arch = "wasm32"))]
21pub mod github_release_updater;
22pub mod haptics;
23pub mod heart_rate;
24#[cfg(not(target_arch = "wasm32"))]
25mod helper_process;
26pub mod host;
27pub mod host_messages;
28pub mod host_surface;
29pub mod http;
30pub mod image_picker;
31pub mod incoming_share;
32pub mod launch_args;
33pub mod launcher;
34pub mod media;
35pub mod memory_pressure;
36pub mod microphone_permission;
37pub mod microphone_standby;
38pub mod navigation;
39pub mod network_status;
40pub mod notifier;
41#[cfg(not(target_arch = "wasm32"))]
42pub mod peer;
43pub mod power;
44pub mod preferences;
45pub mod purchases;
46mod registry;
47pub mod share_sheet;
48pub mod storage;
49pub mod theme;
50pub mod uri_handler;
51pub mod wearable;
52pub mod wearable_framed;
53pub mod writable_folder;
54
55pub use accessibility_options::{
56    AccessibilityOptions, ProvideAccessibilityOptions, local_accessibility_options,
57    platform_accessibility_options, set_platform_accessibility_options,
58};
59pub use accessibility_state::{
60    AccessibilityState, ProvideAccessibilityState, local_accessibility_state,
61    platform_accessibility_state, set_platform_accessibility_state,
62};
63pub use app_info::{
64    AppInfo, AppInfoRef, app_info, build_version, clear_platform_app_info, set_platform_app_info,
65    version_name,
66};
67pub use app_update::{
68    AppUpdateCapabilities, AppUpdateError, AppUpdateObserver, AppUpdateStatus, AppUpdater,
69    AppUpdaterRef, DigestAlgorithm, DigestVerifier, GitHubReleaseUpdate, PackageDigest,
70    UpdatePackage, app_update_capabilities, app_update_checks_supported, app_update_status,
71    app_updates_supported, check_for_app_update, clear_platform_app_updater, install_app_update,
72    observe_app_update_status, set_app_update_status, set_platform_app_updater, sha256_hex,
73    verify_package,
74};
75pub use async_io::{ChunkChannel, ChunkNext, ChunkStream, MAX_PENDING_CHUNKS, Signal, SignalWait};
76pub use audio::{
77    AudioBus, AudioClip, AudioError, AudioPlayer, AudioPlayerRef, NoopAudioPlayer, PlaybackParams,
78    ProvideAudio, SoundBank, SoundBankEntry, SoundBankFailure, SoundId, SoundSpec, VoiceId,
79    clear_platform_audio, default_audio, local_audio, rememberSoundBank, set_platform_audio,
80};
81pub use background::{
82    BackgroundActivity, BackgroundActivityRef, BackgroundWork, BackgroundWorkLease,
83    acquire_background_work, background_active, background_activity,
84    clear_platform_background_activity, set_platform_background_activity,
85};
86#[cfg(not(target_arch = "wasm32"))]
87pub use bundled_assets::{
88    BundledAssetEntry, BundledAssetInstallOutcome, BundledAssetInstallSpec,
89    install_bundled_asset_set,
90};
91pub use bundled_assets::{
92    BundledAssetError, BundledAssetReader, BundledAssets, BundledAssetsRef, StreamingAssetReader,
93    bundled_assets, clear_platform_bundled_assets, set_platform_bundled_assets,
94};
95pub use camera::{
96    Camera, CameraError, CameraFrame, CameraLens, CameraLenses, CameraObserver, CameraRef,
97    CameraState, CameraStill, FlashMode, FrameFormat, LensFacing, UprightRgba, camera,
98    camera_lenses, camera_state, camera_supported, capture_camera_still, clear_platform_camera,
99    dropped_camera_frames, latest_camera_frame, observe_camera_frames, observe_camera_lenses,
100    observe_camera_state, observe_camera_stills, publish_camera_frame, publish_camera_lenses,
101    publish_camera_state, publish_camera_still, record_dropped_camera_frame, rememberCameraFrames,
102    rememberCameraLenses, rememberCameraState, rememberCameraStills, request_camera_still,
103    set_platform_camera, start_camera, stop_camera,
104};
105pub use content::{
106    BytesContent, Content, ContentChannel, ContentEntry, ContentError, ContentFolder,
107    ContentFolderRef, ContentFuture, ContentHandle, ContentMetadata, ContentReader,
108    ContentReaderRef, ContentResolver, ContentResolverRef, ContentSink, ContentSinkRef,
109    ContentStream, ContentStreamRef, DEFAULT_CHUNK_LEN, ReadyFolder,
110    clear_platform_content_resolver, collect_stream, drain_reader, folder_files, percent_decode,
111    percent_decode_lossy, resolve_content, set_platform_content_resolver, write_all,
112};
113#[cfg(not(target_arch = "wasm32"))]
114pub use content::{FileContent, FileFolder, FileSink, file_content, file_folder};
115pub use device_info::{
116    DeviceInfo, DeviceInfoRef, clear_platform_device_info, device_info, release_free_memory,
117    set_platform_device_info,
118};
119pub use file_picker::{
120    FileFilter, FilePicker, FilePickerError, FilePickerOptions, FilePickerRef, PickerFuture,
121    ProvideFilePicker, RecoveredPick, SaveDocumentRequest, clear_platform_file_picker,
122    default_file_picker, local_file_picker, set_platform_file_picker,
123};
124#[cfg(not(target_arch = "wasm32"))]
125pub use github_release_updater::GitHubAppUpdater;
126pub use haptics::{
127    HapticEffect, HapticError, HapticFeedback, HapticPattern, Haptics, HapticsRef, ProvideHaptics,
128    clear_platform_haptics, default_haptics, local_haptics, set_platform_haptics,
129};
130pub use heart_rate::{
131    HeartRate, HeartRateError, HeartRateMonitor, HeartRateMonitorRef, HeartRatePermission,
132    HeartRateReader, HeartRateStatus, clear_platform_heart_rate, heart_rate, heart_rate_available,
133    heart_rate_permission, observe_heart_rate, publish_heart_rate, publish_heart_rate_permission,
134    rememberHeartRate, request_heart_rate_permission, set_platform_heart_rate,
135};
136#[cfg(not(target_arch = "wasm32"))]
137pub use helper_process::windowless_command;
138pub use host::{
139    DEFAULT_DURABLE_SAVE_DEADLINE, DurableSaveEffect, DurableSaveError, DurableSaveOutcome,
140    DurableSaveRegistration, HostController, HostControllerRef, LifecycleEvent, LifecycleObserver,
141    LifecycleState, PlatformDirectories, PlatformDirectoryError, ProvideLifecycle,
142    advance_lifecycle, application_directories, application_id, background_app,
143    clear_application_id, clear_host_controller, current_lifecycle_state, dispatch_lifecycle,
144    dispatch_lifecycle_state, durable_save_deadline, exit_app, host_controller,
145    local_lifecycle_state, observe_lifecycle, register_durable_save, register_preference_save,
146    rememberLifecycleEvents, rememberLifecycleState, run_durable_saves, set_application_id,
147    set_host_controller, set_keep_screen_on, window_lifecycle_state,
148};
149pub use host_messages::{
150    HostMessage, HostMessageObserver, clear_host_messages, clear_host_outbox, install_host_outbox,
151    observe_host_messages, publish_host_message, rememberHostMessages, send_to_host,
152};
153pub use host_surface::{
154    HostSurface, HostSurfaceObserver, HostSurfaceRef, HostSurfaceSize, ResizeRefused,
155    clear_platform_host_surface, host_surface, host_surface_size, observe_host_surface_size,
156    publish_host_surface_size, rememberHostSurfaceSize, request_host_surface_size,
157    set_platform_host_surface,
158};
159pub use http::{
160    BytesBody, CancelTransfer, HttpBody, HttpBodyRef, HttpClient, HttpClientRef, HttpControl,
161    HttpError, HttpFuture, HttpMethod, HttpProgress, HttpRequest, HttpResponse, ProgressHandler,
162    StubAnswer, StubHttpClient, default_http_client, http_body_ref, local_http_client,
163    map_ordered_concurrent,
164};
165#[cfg(not(target_arch = "wasm32"))]
166pub use http::{PlatformDownloader, downloaded_length, set_platform_downloader};
167pub use image_picker::{
168    IMAGE_EXTENSIONS, ImagePicker, ImagePickerError, ImagePickerRef, ImageSource,
169    ProvideImagePicker, clear_platform_image_picker, default_image_picker, local_image_picker,
170    set_platform_image_picker,
171};
172pub use incoming_share::{
173    IncomingContent, IncomingContentObserver, IncomingSource, clear_incoming_content,
174    observe_incoming_content, publish_incoming_content, rememberIncomingContent,
175};
176pub use launch_args::{
177    LaunchArgValue, LaunchArgs, LaunchArgsRef, ProvideLaunchArgs, clear_platform_launch_args,
178    is_debuggable, isDebuggable, launch_args, launch_args_from_command_line, local_launch_args,
179    set_platform_launch_args,
180};
181pub use launcher::{
182    LauncherResult, OpenFileLauncher, OpenFilesLauncher, OpenFolderLauncher, SaveDocumentLauncher,
183    WritableFolderLauncher, clear_launcher_state, rememberOpenFileLauncher,
184    rememberOpenFilesLauncher, rememberOpenFolderLauncher, rememberSaveDocumentLauncher,
185    rememberWritableFolderLauncher,
186};
187pub use media::{
188    AudioFocus, DUCKED_GAIN, EqualizerBand, EqualizerSettings, MediaArtwork, MediaCapabilities,
189    MediaCommand, MediaError, MediaItem, MediaMetadata, MediaObserver, MediaPlayer, MediaPlayerRef,
190    MediaSamples, MediaSourceHandle, MediaSourceOpener, MediaSourceOpenerRef,
191    OCTAVE_BAND_CENTERS_HZ, PlaybackProgress, PlaybackState, audio_focus,
192    clear_platform_media_player, clear_platform_media_source_opener, current_media_item,
193    dropped_media_samples, latest_media_samples, media_capabilities, media_equalizer,
194    media_equalizer_bands, media_playback_supported, media_player, media_volume,
195    observe_audio_focus, observe_media_commands, observe_media_samples, observe_playback_progress,
196    observe_playback_state, octave_equalizer_bands, open_media, open_media_source, path_from_uri,
197    pause_media, play_media, playback_progress, playback_state, probe_media_duration,
198    publish_audio_focus, publish_media_command, publish_media_samples, publish_playback_progress,
199    publish_playback_state, record_dropped_media_samples, rememberAudioFocus,
200    rememberMediaCommands, rememberMediaSamples, rememberPlaybackProgress, rememberPlaybackState,
201    seek_media, seek_media_fraction, set_media_analysis_enabled, set_media_balance,
202    set_media_equalizer, set_media_looping, set_media_metadata, set_media_speed, set_media_volume,
203    set_platform_media_player, set_platform_media_source_opener, stop_media, toggle_media,
204    uri_for_path,
205};
206pub use memory_pressure::{
207    MemoryPressure, MemoryPressureObserver, observe_memory_pressure, publish_memory_pressure,
208    rememberMemoryPressure,
209};
210pub use microphone_permission::{
211    MicrophoneAccess, MicrophonePermission, MicrophonePermissionObserver, microphone_permission,
212    observe_microphone_permission, open_microphone_settings, prepare_microphone,
213    publish_microphone_permission, rememberMicrophonePermission, request_microphone_permission,
214    set_platform_microphone_access,
215};
216pub use microphone_standby::{
217    MicrophoneStandby, MicrophoneStandbyLease, hold_microphone_standby,
218    microphone_standby_available, set_platform_microphone_standby,
219};
220pub use navigation::{
221    BackHandler, BackRequestObserver, back_interception_enabled, exit_requested,
222    observe_back_requests, push_back_request, request_exit, set_back_interception,
223    take_back_requests, take_exit_request,
224};
225pub use network_status::{
226    NetworkMonitor, NetworkMonitorRef, NetworkStatus, clear_platform_network_monitor,
227    network_monitor, network_status, set_platform_network_monitor,
228};
229pub use notifier::{
230    Notifier, NotifierRef, NotifyRequest, ProvideNotifier, clear_platform_notifier,
231    default_notifier, local_notifier, push_notification_deeplink, set_platform_notifier,
232    take_notification_deeplink,
233};
234#[cfg(not(target_arch = "wasm32"))]
235pub use peer::{
236    ByteSource, BytesSource, FetchResult, PeerError, PeerServer, SourceResolver, content_length,
237    fetch_range, fetch_to_writer,
238};
239pub use power::{
240    BatteryStatus, PowerCapabilities, PowerMonitor, PowerMonitorRef, PowerObserverRegistration,
241    PowerReading, PowerState, ThermalState, clear_platform_power_monitor, observe_power_state,
242    power_capabilities, power_monitor, power_state, publish_power_state, rememberPowerState,
243    set_platform_power_monitor,
244};
245#[cfg(all(target_arch = "wasm32", feature = "preferences-web"))]
246pub use preferences::BrowserPreferences;
247#[cfg(not(target_arch = "wasm32"))]
248pub use preferences::FilePreferences;
249pub use preferences::{
250    MemoryPreferences, PreferencesError, PreferencesRef, PreferencesStore, Saver,
251    clear_platform_preferences, preferences, rememberSaveable, set_platform_preferences,
252};
253pub use purchases::{
254    Product, PurchaseEvent, Purchases, PurchasesRef, StoreObserver, StorePhase, StoreState,
255    clear_platform_purchases, note_store_news, observe_store_news, purchases,
256    rememberPurchaseEvents, rememberStoreState, set_platform_purchases, store_available,
257    store_state,
258};
259pub use share_sheet::{
260    ProvideShareSheet, ShareContent, ShareError, ShareSheet, ShareSheetRef,
261    clear_platform_share_sheet, default_share_sheet, local_share_sheet, set_platform_share_sheet,
262};
263pub use storage::{StorageSpace, StorageSpaceRef, available_storage, set_platform_storage_space};
264pub use theme::{
265    ProvideSystemTheme, SystemTheme, clear_platform_system_theme, default_system_theme,
266    isSystemInDarkTheme, local_system_theme, set_platform_system_theme,
267};
268pub use uri_handler::{
269    ProvideUriHandler, UriHandler, UriHandlerError, UriHandlerRef, clear_platform_uri_handler,
270    default_uri_handler, local_uri_handler, set_platform_uri_handler,
271};
272pub use wearable::{
273    WearableError, WearableEvent, WearableLink, WearablePeer, WearableReceiver, WearableStream,
274    open_on_wearable_peer, open_wearable_stream, publish_wearable_event, send_wearable_message,
275    set_platform_wearable_link, set_wearable_receiver, wearable_peers,
276};
277pub use wearable_framed::{FramedWearableLink, WearableTransport};
278pub use writable_folder::{
279    FolderEntry, FolderError, FolderReader, FolderWriter, WritableFolderStore,
280    WritableFolderStoreRef, open_writable_folder, set_writable_folder_store_factory,
281};
282
283#[cfg(test)]
284pub(crate) type TestComposition = Composition<MemoryApplier>;
285
286#[cfg(test)]
287pub(crate) fn test_scratch_dir(tag: &str) -> std::path::PathBuf {
288    cranpose_core::test_scratch_dir(env!("CARGO_MANIFEST_DIR"), tag)
289}
290
291#[cfg(test)]
292pub(crate) fn run_test_composition(build: impl FnMut()) -> TestComposition {
293    let mut composition = Composition::new(MemoryApplier::new());
294    composition
295        .render(location_key(file!(), line!(), column!()), build)
296        .expect("initial render succeeds");
297    composition
298}
299
300/// What a composable read while a test composition ran once, or `None` when
301/// the read never ran.
302#[cfg(test)]
303pub(crate) fn captured_in_composition<T: Copy + 'static>(
304    read: impl Fn() -> T + 'static,
305) -> Option<T> {
306    let captured = std::rc::Rc::new(std::cell::Cell::new(None));
307    let sink = std::rc::Rc::clone(&captured);
308    run_test_composition(move || sink.set(Some(read())));
309    captured.get()
310}
cranpose_services/lib.rs

cranpose_services/
lib.rs
