pub struct ProjectBulkOperationLock<'a> { /* private fields */ }
Implementations§
Methods from Deref<Target = Project>§
sourcepub fn set_name<S: BnStrCompatible>(&self, value: S)
pub fn set_name<S: BnStrCompatible>(&self, value: S)
Set the name of the project
sourcepub fn description(&self) -> BnString
pub fn description(&self) -> BnString
Get the description of the project
sourcepub fn set_description<S: BnStrCompatible>(&self, value: S)
pub fn set_description<S: BnStrCompatible>(&self, value: S)
Set the description of the project
sourcepub fn query_metadata<S: BnStrCompatible>(&self, key: S) -> Ref<Metadata>
pub fn query_metadata<S: BnStrCompatible>(&self, key: S) -> Ref<Metadata>
Retrieves metadata stored under a key from the project
sourcepub fn store_metadata<S: BnStrCompatible>(
&self,
key: S,
value: &Metadata,
) -> bool
pub fn store_metadata<S: BnStrCompatible>( &self, key: S, value: &Metadata, ) -> bool
Stores metadata within the project,
key
- Key under which to store the Metadata objectvalue
- Object to store
sourcepub fn remove_metadata<S: BnStrCompatible>(&self, key: S)
pub fn remove_metadata<S: BnStrCompatible>(&self, key: S)
Removes the metadata associated with this key
from the project
pub fn push_folder(&self, file: &ProjectFolder)
sourcepub fn create_folder_from_path<P, D>(
&self,
path: P,
parent: Option<&ProjectFolder>,
description: D,
) -> Result<Ref<ProjectFolder>, ()>where
P: BnStrCompatible,
D: BnStrCompatible,
pub fn create_folder_from_path<P, D>(
&self,
path: P,
parent: Option<&ProjectFolder>,
description: D,
) -> Result<Ref<ProjectFolder>, ()>where
P: BnStrCompatible,
D: BnStrCompatible,
Recursively create files and folders in the project from a path on disk
path
- Path to folder on diskparent
- Parent folder in the project that will contain the new contentsdescription
- Description for created root folder
sourcepub fn create_folder_from_path_with_progress<P, D, PC>(
&self,
path: P,
parent: Option<&ProjectFolder>,
description: D,
progress: PC,
) -> Result<Ref<ProjectFolder>, ()>
pub fn create_folder_from_path_with_progress<P, D, PC>( &self, path: P, parent: Option<&ProjectFolder>, description: D, progress: PC, ) -> Result<Ref<ProjectFolder>, ()>
Recursively create files and folders in the project from a path on disk
path
- Path to folder on diskparent
- Parent folder in the project that will contain the new contentsdescription
- Description for created root folderprogress
-ProgressCallback
that will be called as theProjectFolder
is being created
sourcepub fn create_folder<N, D>(
&self,
parent: Option<&ProjectFolder>,
name: N,
description: D,
) -> Result<Ref<ProjectFolder>, ()>where
N: BnStrCompatible,
D: BnStrCompatible,
pub fn create_folder<N, D>(
&self,
parent: Option<&ProjectFolder>,
name: N,
description: D,
) -> Result<Ref<ProjectFolder>, ()>where
N: BnStrCompatible,
D: BnStrCompatible,
Recursively create files and folders in the project from a path on disk
parent
- Parent folder in the project that will contain the new foldername
- Name for the created folderdescription
- Description for created folder
sourcepub unsafe fn create_folder_unsafe<N, D, I>(
&self,
parent: Option<&ProjectFolder>,
name: N,
description: D,
id: I,
) -> Result<Ref<ProjectFolder>, ()>
pub unsafe fn create_folder_unsafe<N, D, I>( &self, parent: Option<&ProjectFolder>, name: N, description: D, id: I, ) -> Result<Ref<ProjectFolder>, ()>
Recursively create files and folders in the project from a path on disk
parent
- Parent folder in the project that will contain the new foldername
- Name for the created folderdescription
- Description for created folderid
- id unique ID
sourcepub fn folder_by_id<S: BnStrCompatible>(
&self,
id: S,
) -> Option<Ref<ProjectFolder>>
pub fn folder_by_id<S: BnStrCompatible>( &self, id: S, ) -> Option<Ref<ProjectFolder>>
Retrieve a folder in the project by unique folder id
sourcepub fn delete_folder(&self, folder: &ProjectFolder) -> Result<(), ()>
pub fn delete_folder(&self, folder: &ProjectFolder) -> Result<(), ()>
Recursively delete a ProjectFolder
from the Project
.
folder
-ProjectFolder
to delete recursively
sourcepub fn delete_folder_with_progress<P: ProgressCallback>(
&self,
folder: &ProjectFolder,
progress: P,
) -> Result<(), ()>
pub fn delete_folder_with_progress<P: ProgressCallback>( &self, folder: &ProjectFolder, progress: P, ) -> Result<(), ()>
Recursively delete a ProjectFolder
from the Project
.
folder
-ProjectFolder
to delete recursivelyprogress
-ProgressCallback
that will be called as objects get deleted
pub fn push_file(&self, file: &ProjectFile)
sourcepub fn create_file_from_path<P, N, D>(
&self,
path: P,
folder: Option<&ProjectFolder>,
name: N,
description: D,
) -> Result<Ref<ProjectFile>, ()>
pub fn create_file_from_path<P, N, D>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D, ) -> Result<Ref<ProjectFile>, ()>
Create a file in the project from a path on disk
path
- Path on diskfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created file
sourcepub fn create_file_from_path_with_progress<P, N, D, PC>(
&self,
path: P,
folder: Option<&ProjectFolder>,
name: N,
description: D,
progress: PC,
) -> Result<Ref<ProjectFile>, ()>
pub fn create_file_from_path_with_progress<P, N, D, PC>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D, progress: PC, ) -> Result<Ref<ProjectFile>, ()>
Create a file in the project from a path on disk
path
- Path on diskfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created fileprogress
-ProgressCallback
that will be called as theProjectFile
is being added
sourcepub unsafe fn create_file_from_path_unsafe<P, N, D, I>(
&self,
path: P,
folder: Option<&ProjectFolder>,
name: N,
description: D,
id: I,
creation_time: SystemTime,
) -> Result<Ref<ProjectFile>, ()>
pub unsafe fn create_file_from_path_unsafe<P, N, D, I>( &self, path: P, folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime, ) -> Result<Ref<ProjectFile>, ()>
Create a file in the project from a path on disk
path
- Path on diskfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created fileid
- id unique IDcreation_time
- Creation time of the file
sourcepub unsafe fn create_file_from_path_unsafe_with_progress<P, N, D, I, PC>(
&self,
path: P,
folder: Option<&ProjectFolder>,
name: N,
description: D,
id: I,
creation_time: SystemTime,
progress: PC,
) -> Result<Ref<ProjectFile>, ()>where
P: BnStrCompatible,
N: BnStrCompatible,
D: BnStrCompatible,
I: BnStrCompatible,
PC: ProgressCallback,
pub unsafe fn create_file_from_path_unsafe_with_progress<P, N, D, I, PC>(
&self,
path: P,
folder: Option<&ProjectFolder>,
name: N,
description: D,
id: I,
creation_time: SystemTime,
progress: PC,
) -> Result<Ref<ProjectFile>, ()>where
P: BnStrCompatible,
N: BnStrCompatible,
D: BnStrCompatible,
I: BnStrCompatible,
PC: ProgressCallback,
Create a file in the project from a path on disk
path
- Path on diskfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created fileid
- id unique IDcreation_time
- Creation time of the fileprogress
-ProgressCallback
that will be called as theProjectFile
is being created
sourcepub fn create_file<N, D>(
&self,
contents: &[u8],
folder: Option<&ProjectFolder>,
name: N,
description: D,
) -> Result<Ref<ProjectFile>, ()>where
N: BnStrCompatible,
D: BnStrCompatible,
pub fn create_file<N, D>(
&self,
contents: &[u8],
folder: Option<&ProjectFolder>,
name: N,
description: D,
) -> Result<Ref<ProjectFile>, ()>where
N: BnStrCompatible,
D: BnStrCompatible,
Create a file in the project
contents
- Bytes of the file that will be createdfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created file
sourcepub fn create_file_with_progress<N, D, P>(
&self,
contents: &[u8],
folder: Option<&ProjectFolder>,
name: N,
description: D,
progress: P,
) -> Result<Ref<ProjectFile>, ()>
pub fn create_file_with_progress<N, D, P>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D, progress: P, ) -> Result<Ref<ProjectFile>, ()>
Create a file in the project
contents
- Bytes of the file that will be createdfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created fileprogress
-ProgressCallback
that will be called as theProjectFile
is being created
sourcepub unsafe fn create_file_unsafe<N, D, I>(
&self,
contents: &[u8],
folder: Option<&ProjectFolder>,
name: N,
description: D,
id: I,
creation_time: SystemTime,
) -> Result<Ref<ProjectFile>, ()>
pub unsafe fn create_file_unsafe<N, D, I>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime, ) -> Result<Ref<ProjectFile>, ()>
Create a file in the project
contents
- Bytes of the file that will be createdfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created fileid
- id unique IDcreation_time
- Creation time of the file
sourcepub unsafe fn create_file_unsafe_with_progress<N, D, I, P>(
&self,
contents: &[u8],
folder: Option<&ProjectFolder>,
name: N,
description: D,
id: I,
creation_time: SystemTime,
progress: P,
) -> Result<Ref<ProjectFile>, ()>
pub unsafe fn create_file_unsafe_with_progress<N, D, I, P>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: N, description: D, id: I, creation_time: SystemTime, progress: P, ) -> Result<Ref<ProjectFile>, ()>
Create a file in the project
contents
- Bytes of the file that will be createdfolder
- Folder to place the created file inname
- Name to assign to the created filedescription
- Description to assign to the created fileid
- id unique IDcreation_time
- Creation time of the fileprogress
-ProgressCallback
that will be called as theProjectFile
is being created
sourcepub fn files(&self) -> Array<ProjectFile>
pub fn files(&self) -> Array<ProjectFile>
Get a list of files in the project
sourcepub fn file_by_id<S: BnStrCompatible>(&self, id: S) -> Option<Ref<ProjectFile>>
pub fn file_by_id<S: BnStrCompatible>(&self, id: S) -> Option<Ref<ProjectFile>>
Retrieve a file in the project by unique id
sourcepub fn file_by_path<S: BnStrCompatible>(
&self,
path: S,
) -> Option<Ref<ProjectFile>>
pub fn file_by_path<S: BnStrCompatible>( &self, path: S, ) -> Option<Ref<ProjectFile>>
Retrieve a file in the project by the path
on disk
sourcepub fn delete_file(&self, file: &ProjectFile) -> bool
pub fn delete_file(&self, file: &ProjectFile) -> bool
Delete a file from the project