Struct File

pub struct File<'a> { /* private fields */ }

Abstraction of a file object, it implements Object, you may want to use this struct to create a tree representation of one storage.

Implementations

impl File<'_>

pub fn storage_id(&self) -> u32

Returns the id of the storage it belongs to.

pub fn parent_id(&self) -> Parent

Returns the id of its parent.

pub fn size(&self) -> u64

Returns the size of this file.

pub fn name(&self) -> &str

Returns the name of this file.

pub fn ftype(&self) -> Filetype

Returns the type of this file.

pub fn modification_date(&self) -> DateTime<Utc>

Returns the latest modification date in UTC.

pub fn rename(&mut self, new_name: &str) -> Result<()>

Rename this file in-place.

Trait Implementations

impl Debug for File<'_>

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

Formats the value using the given formatter.

impl Drop for File<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Object for &File<'_>

fn id(&self) -> u32

Must return the id of the object.

fn device(&self) -> &MtpDevice

Must return a valid reference of an MtpDevice, where this object resides in.

fn get_string(&self, property: Property) -> Result<String>

Retrieves a string from an object attribute.

fn set_string(&self, property: Property, string: &str) -> Result<()>

Sets an object attribute from a string.

fn get_u64(&self, property: Property) -> Result<u64>

Retrieves an u64 from an object attribute.

fn get_u32(&self, property: Property) -> Result<u32>

Retrieves an u32 from an object attribute, returns the value of default on failure.

fn set_u32(&self, property: Property, value: u32) -> Result<()>

Sets an object attribute from an u32.

fn get_u16(&self, property: Property) -> Result<u16>

Retrieves an u16 from an object attribute, returns the value of default on failure.

fn set_u16(&self, property: Property, value: u16) -> Result<()>

Sets an object attribute from an u16.

fn get_u8(&self, property: Property) -> Result<u8>

Retrieves an u8 from an object attribute, returns the value of default on failure.

fn set_u8(&self, property: Property, value: u8) -> Result<()>

Sets an object attribute from an u8.

fn delete(&self) -> Result<()>

Deletes a single file, track, playlist, folder or any other object off the MTP device. Note that deleting folders may no be remove its contents, in turn this is the expected behavior.

fn move_to(&self, storage_id: u32, parent: Parent) -> Result<()>

Moves the object to the specified storage (by its id) and parent folder. Moving objects may or not be supported on the device.

fn copy_to(&self, storage_id: u32, parent: Parent) -> Result<()>

Copies the object to the specified storage (by its id) and parent folder. Copying objects may or not be supported on the device.

fn get_partial_object(&self, offset: u64, maxbytes: u32) -> Result<Vec<u8>>

Get partial data from an object, specifying an offset and the maximum bytes that should be read. Note that this may return fewer bytes than the maximum.

fn send_partial_object(&self, offset: u64, data: impl AsRef<[u8]>) -> Result<()>

Send partial data to an object, specifying an offset and the data you want to write into the object.

impl Object for File<'_>

fn id(&self) -> u32

Must return the id of the object.

fn device(&self) -> &MtpDevice

Must return a valid reference of an MtpDevice, where this object resides in.

fn get_string(&self, property: Property) -> Result<String>

Retrieves a string from an object attribute.

fn set_string(&self, property: Property, string: &str) -> Result<()>

Sets an object attribute from a string.

fn get_u64(&self, property: Property) -> Result<u64>

Retrieves an u64 from an object attribute.

fn get_u32(&self, property: Property) -> Result<u32>

Retrieves an u32 from an object attribute, returns the value of default on failure.

fn set_u32(&self, property: Property, value: u32) -> Result<()>

Sets an object attribute from an u32.

fn get_u16(&self, property: Property) -> Result<u16>

Retrieves an u16 from an object attribute, returns the value of default on failure.

fn set_u16(&self, property: Property, value: u16) -> Result<()>

Sets an object attribute from an u16.

fn get_u8(&self, property: Property) -> Result<u8>

Retrieves an u8 from an object attribute, returns the value of default on failure.

fn set_u8(&self, property: Property, value: u8) -> Result<()>

Sets an object attribute from an u8.

fn delete(&self) -> Result<()>

Deletes a single file, track, playlist, folder or any other object off the MTP device. Note that deleting folders may no be remove its contents, in turn this is the expected behavior.

fn move_to(&self, storage_id: u32, parent: Parent) -> Result<()>

Moves the object to the specified storage (by its id) and parent folder. Moving objects may or not be supported on the device.

fn copy_to(&self, storage_id: u32, parent: Parent) -> Result<()>

Copies the object to the specified storage (by its id) and parent folder. Copying objects may or not be supported on the device.

fn get_partial_object(&self, offset: u64, maxbytes: u32) -> Result<Vec<u8>>

Get partial data from an object, specifying an offset and the maximum bytes that should be read. Note that this may return fewer bytes than the maximum.

fn send_partial_object(&self, offset: u64, data: impl AsRef<[u8]>) -> Result<()>

Send partial data to an object, specifying an offset and the data you want to write into the object.