cranpose_services/
lib.rs

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

cranpose_services/
lib.rs
