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

cranpose_services/
lib.rs
