Struct File

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

A file on the storage.

Implementations

impl<'a> File<'a>

pub fn id(&self) -> u32

Retrieves the ID of the file.

pub fn name(&self) -> &str

Retrieves the name of the file.

Panics

Panics if the name of the file is not a valid UTF-8.

Examples found in repository

examples/copy-to-host.rs (line 9)

fn main() -> libmtp::Result<()> {
	let device = Device::from_serial("GVEV4I3E0WU1")?.expect("Device should exist");
	let storage = device.find_storage(65537).expect("Storage should exist");
	for object in storage.iter_recursive() {
		if let Object::File(file) = object {
			let path = format!("/tmp/libmtp-{}", file.name());
			file.copy_to_host(path)?;
			break;
		}
	}
	Ok(())
}

pub fn kind(&self) -> FileKind

Retrieves the kind of the file.

pub fn size(&self) -> u64

Retrieves the total size in bytes of the file.

pub fn rename<'b>(&self, name: &'b str) -> Result<()>

Changes the name of the file.

Errors

Returns an error if a sibling object with the same name already exists or if the operation has failed.

Panics

Panics if the name of the file contains a nul byte.

pub fn move_to(&self, parent: Folder<'_>) -> Result<()>

Moves the file to the other folder.

Errors

Returns an error if an object with the same name already exists in the other folder or if the operation has failed.

pub fn copy_to(&self, parent: Folder<'_>) -> Result<()>

Copies the file to the other folder.

Errors

Returns an error if an object with the same name already exists in the other folder or if the operation has failed.

pub fn copy_to_host<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Copies the file to the host computer.

Errors

Returns an error if the operation has failed.

Examples found in repository

examples/copy-to-host.rs (line 10)

fn main() -> libmtp::Result<()> {
	let device = Device::from_serial("GVEV4I3E0WU1")?.expect("Device should exist");
	let storage = device.find_storage(65537).expect("Storage should exist");
	for object in storage.iter_recursive() {
		if let Object::File(file) = object {
			let path = format!("/tmp/libmtp-{}", file.name());
			file.copy_to_host(path)?;
			break;
		}
	}
	Ok(())
}

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

Deletes the file from the storage.

Errors

Returns an error if the operation has failed.

Trait Implementations

impl<'a> Clone for File<'a>

fn clone(&self) -> File<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for File<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for File<'a>

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.