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

cranpose_services/
lib.rs
