Struct FileUri 

pub struct FileUri {
    pub uri: String,
    pub document_top_tree_uri: Option<String>,
}

URI to represent a file or directory.

TypeScript

type FileUri = {
    uri: string,
    documentTopTreeUri: string | null
}

Fields

uri: String

URI pointing to a file or directory.

This uses either the content:// scheme or the file:// scheme.

document_top_tree_uri: Option<String>

Tree URI of the origin directory to which this entry belongs.

This is present for directories obtained via a directory picker and for entries derived from them.

Implementations

impl FileUri

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

Same as serde_json::to_string(...)

pub fn from_json_str(json: impl AsRef<str>) -> Result<Self>

Same as serde_json::from_str(...)

pub fn from_uri(uri: impl Into<String>) -> Self

pub fn from_path(path: impl AsRef<Path>) -> Self

Constructs a URI from the absolute path of a file or directory.

This must be an absolute path that does not contain ./ or ../. Even if the path is invalid, it will not cause an error or panic; an invalid URI will be returned.

Note

There are a few points to note regarding this.

• This URI cannot be passed to functions of FileOpener for sending to other apps.
• Operations using this URI may fall back to std::fs instead of Kotlin API.

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

If this URI is an Android file-scheme URI, for example, via FileUri::from_path, its absolute path will be retrieved.

pub fn is_file_scheme(&self) -> bool

Indicates whether this is file:// URI.

pub fn is_content_scheme(&self) -> bool

Indicates whether this is content:// URI.

pub fn is_file_uri(&self) -> bool

👎Deprecated:

Use is_file_scheme instead

pub fn is_content_uri(&self) -> bool

👎Deprecated:

Use is_content_scheme instead

Trait Implementations

impl Clone for FileUri

fn clone(&self) -> FileUri

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileUri

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileUri

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Path> for FileUri

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&PathBuf> for FileUri

fn from(path: &PathBuf) -> Self

Converts to this type from the input type.

impl From<FilePath> for FileUri

fn from(value: FilePath) -> Self

Converts to this type from the input type.

impl From<FileUri> for FilePath

fn from(value: FileUri) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FileUri

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl Hash for FileUri

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileUri

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FileUri

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FileUri

impl StructuralPartialEq for FileUri