Struct FsUri 

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

URI for a file or directory.

Note

Serialized by serde as:

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

Fields

uri: String

URI for a file or directory.

Note

This is a URI with either the content or file scheme.

document_top_tree_uri: Option<String>

Document tree URI of the root directory from which this entry originates.

Note

This field is set for directories obtained via Directory Picker and for entries derived from those directories.

Implementations

impl FsUri

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.

Note

The path must be absolute and must not contain ./ or ../. Even if the path is invalid, this function will not return an error or panic; instead, it returns an invalid URI.

Note the following:

• This URI cannot be used with Opener to open files in other apps.
• Operations using this URI may fall back to std::fs instead of the Kotlin API.

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

Returns the path if this URI uses the file scheme; otherwise, returns None.

pub fn is_file_scheme(&self) -> bool

Returns true if this URI uses the file scheme.

pub fn is_content_scheme(&self) -> bool

Returns true if this URI uses the content scheme.

Trait Implementations

impl Clone for FsUri

fn clone(&self) -> FsUri

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FsUri

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FsUri

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FsUri

impl From<&Path> for FsUri

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&PathBuf> for FsUri

fn from(path: &PathBuf) -> Self

Converts to this type from the input type.

impl From<FilePath> for FsUri

fn from(value: FilePath) -> Self

Converts to this type from the input type.

impl From<FsUri> for FilePath

fn from(value: FsUri) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FsUri

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl Hash for FsUri

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 FsUri

fn eq(&self, other: &FsUri) -> 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 FsUri

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FsUri