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

cranpose_services/
lib.rs
