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

cranpose_services/
lib.rs
