cranpose_services/
lib.rs

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

cranpose_services/
lib.rs
