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

cranpose_services/
lib.rs
