Struct Folder 

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

A folder on the storage.

Implementations

impl<'a> Folder<'a>

pub fn id(&self) -> u32

Retrieves the ID of the folder.

pub fn name(&self) -> &str

Retrieves the name of the folder.

Panics

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

pub fn owner(&self) -> &Storage<'_>

Retrieves the storage to which the folder belongs.

pub fn parent(&self) -> Option<&Folder<'_>>

Retrieves the folder to which the folder belongs.

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

Changes the name of the foler.

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 folder contains a nul byte.

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

Moves the folder 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 folder 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 delete(&self) -> Result<()>

Deletes the folder from the storage.

Errors

Returns an error if the operation has failed.

pub fn create_folder(&self, name: &str) -> Result<u32>

Creates a new folder inside the folder. Returns the ID of the created folder.

Errors

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

Panics

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

pub fn copy_file_from_host<P>(&self, path: P, kind: FileKind) -> Result<()>

where P: AsRef<Path>,

Copies the file from the host computer to the folder.

Errors

Returns an error if reading the file’s metadata has failed or if the operation has failed.

Panics

Panics if the path doesn’t end in file name, or if file name is not a valid UTF-8.

Examples found in repository

examples/copy-from-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::Folder(folder) = object {
			folder.copy_file_from_host("/tmp/hello.txt", FileKind::Text)?;
			break;
		}
	}
	Ok(())
}

pub fn iter(&self) -> ObjectIter<'_>

Retrieves an iterator over the objects of the folder.

pub fn iter_recursive(&self) -> ObjectRecursiveIter<'_>

Retrieves a recursive iterator over the objects of the folder.

Trait Implementations

impl<'a> Clone for Folder<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Folder<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for Folder<'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.

impl<'a> IntoIterator for &'a Folder<'a>

type Item = Object<'a>

The type of the elements being iterated over.

type IntoIter = ObjectIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.