Skip to main content

FileUrl

Struct FileUrl 

Source
pub struct FileUrl(/* private fields */);
Expand description

A cross-platform handle to a file the user chose in a native open/save picker.

Internally a single locator string. On desktop and iOS it is an absolute filesystem path; on Android it may be a content:// URI, since the Storage Access Framework does not expose real filesystem paths. That is why Day uses a bespoke type rather than std::path::PathBuf (which cannot represent a content:// URI) or a bare String (no type-safety / helpers): a FileUrl is the lossless union with ergonomic accessors.

Files returned from open_file are always readable via FileUrl::read_to_string / FileUrl::read: backends copy a picked file into app storage first where the platform requires it, so the local path works everywhere.

Implementations§

Source§

impl FileUrl

Source

pub fn new(locator: impl Into<String>) -> Self

Wrap a locator string (a filesystem path or a URI). Usually produced by the pickers.

Source

pub fn as_str(&self) -> &str

The raw locator: a filesystem path, or a content://-style URI on Android.

Source

pub fn local_path(&self) -> Option<PathBuf>

The locator as a filesystem path: Some for local paths (and file:// URLs), None for opaque URIs such as Android’s content://.

Source

pub fn bookmark(&self, read_only: bool) -> Result<Vec<u8>>

Persistable macOS security-scoped bookmark for a file the user has authorized. Store the opaque bytes in app-private storage, not the path. Other platforms return Unsupported. read_only prevents a bookmark from requesting write access.

§Errors

Returns an Unsupported error off macOS, and the system’s error when the bookmark cannot be created.

Source

pub fn resolve_bookmark(bytes: &[u8]) -> Result<FileAccess>

Resolve a saved macOS bookmark and hold its security scope until the returned guard is dropped. Keep the guard alive across all I/O, including asynchronous operations.

§Errors

Returns an Unsupported error off macOS, and the system’s error when the bookmark is stale or cannot be resolved.

Source

pub fn file_name(&self) -> Option<String>

The last path component, for display (e.g. notes.txt). Best-effort for opaque URIs.

Source

pub fn read(&self) -> Result<Vec<u8>>

Read the file’s bytes. Local paths only; opaque URIs return an Unsupported error.

§Errors

Returns an Unsupported error for an opaque URI, and the file system’s error when the read fails.

Source

pub async fn read_limited(&self, limit: usize) -> Result<Vec<u8>>

Read at most limit bytes without blocking the UI. Native reads run on a worker; browser-picked bytes are already in memory. Oversized input returns InvalidData. Apple security-scoped access is held for the read and released on every exit path.

§Errors

Returns InvalidData when the file is larger than limit, Unsupported for an opaque URI, and the file system’s error when the read fails.

Source

pub fn read_to_string(&self) -> Result<String>

Read the file as UTF-8 text.

§Errors

Returns an Unsupported error for an opaque URI, InvalidData when the bytes are not UTF-8, and the file system’s error when the read fails.

Trait Implementations§

Source§

impl Clone for FileUrl

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileUrl

Source§

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

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

impl Display for FileUrl

Source§

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

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

impl Eq for FileUrl

Source§

impl Hash for FileUrl

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for FileUrl

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FileUrl

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

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

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoReactive<T, StaticMark> for T
where T: Clone + 'static,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.