Skip to main content

FilePicker

Struct FilePicker 

Source
pub struct FilePicker;
Expand description

Frontend-agnostic file picker that delegates to the native platform dialog.

FilePicker has no state and is cheap to construct. All methods return standard Future values that can be awaited from any async runtime, including pollster::block_on for synchronous contexts.

§Examples

use loki_file_access::{FilePicker, PickOptions};

let picker = FilePicker::new();
let token = picker
    .pick_file_to_open(PickOptions::default())
    .await?;

if let Some(token) = token {
    println!("Selected: {}", token.display_name());
}

Implementations§

Source§

impl FilePicker

Source

pub fn new() -> Self

Create a new FilePicker instance.

Source

pub async fn pick_file_to_open( &self, options: PickOptions, ) -> Result<Option<FileAccessToken>, PickerError>

Present a platform dialog for the user to select a single file.

Returns Ok(Some(token)) if the user selected a file, or Ok(None) if the user cancelled the dialog. The multi field of options is ignored — use pick_files_to_open for multi-selection.

§Errors

Returns PickerError if the platform dialog could not be presented.

Source

pub async fn pick_files_to_open( &self, options: PickOptions, ) -> Result<Vec<FileAccessToken>, PickerError>

Present a platform dialog for the user to select multiple files.

Returns a (possibly empty) vector of tokens. An empty vector means the user cancelled the dialog. The multi field of options is forced to true.

§Errors

Returns PickerError if the platform dialog could not be presented.

Source

pub async fn pick_file_to_save( &self, options: SaveOptions, ) -> Result<Option<FileAccessToken>, PickerError>

Present a platform dialog for the user to choose a save location.

Returns Ok(Some(token)) if the user confirmed a save location, or Ok(None) if the user cancelled.

§Platform notes

On WASM, this triggers a browser download via a Blob URL rather than presenting a traditional save dialog. The returned token wraps an in-memory buffer.

§Errors

Returns PickerError if the platform dialog could not be presented.

Trait Implementations§

Source§

impl Clone for FilePicker

Source§

fn clone(&self) -> FilePicker

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FilePicker

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for FilePicker

Source§

fn default() -> FilePicker

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more