cranpose_services/
lib.rs

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

cranpose_services/
lib.rs
