Struct ProjectBulkOperationLock

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

Implementations

impl<'a> ProjectBulkOperationLock<'a>

pub fn lock(project: &'a mut Project) -> Self

pub fn unlock(self)

Methods from Deref<Target = Project>

pub fn is_open(&self) -> bool

Check if the project is currently open

pub fn open(&self) -> Result<(), ()>

Open a closed project

pub fn close(&self) -> Result<(), ()>

Close a open project

pub fn id(&self) -> String

Get the unique id of this project

pub fn path(&self) -> String

Get the path of the project

pub fn name(&self) -> String

Get the name of the project

pub fn set_name(&self, value: &str)

Set the name of the project

pub fn description(&self) -> String

Get the description of the project

pub fn set_description(&self, value: &str)

Set the description of the project

pub fn query_metadata(&self, key: &str) -> Ref<Metadata>

Retrieves metadata stored under a key from the project

pub fn store_metadata(&self, key: &str, value: &Metadata) -> bool

Stores metadata within the project,

• key - Key under which to store the Metadata object
• value - Object to store

pub fn remove_metadata(&self, key: &str)

Removes the metadata associated with this key from the project

pub fn push_folder(&self, file: &ProjectFolder)

pub fn create_folder_from_path( &self, path: &str, parent: Option<&ProjectFolder>, description: &str, ) -> Result<Ref<ProjectFolder>, ()>

Recursively create files and folders in the project from a path on disk

• path - Path to folder on disk
• parent - Parent folder in the project that will contain the new contents
• description - Description for created root folder

pub fn create_folder_from_path_with_progress<PC>( &self, path: &str, parent: Option<&ProjectFolder>, description: &str, progress: PC, ) -> Result<Ref<ProjectFolder>, ()>

where PC: ProgressCallback,

Recursively create files and folders in the project from a path on disk

• path - Path to folder on disk
• parent - Parent folder in the project that will contain the new contents
• description - Description for created root folder
• progress - ProgressCallback that will be called as the ProjectFolder is being created

pub fn create_folder( &self, parent: Option<&ProjectFolder>, name: &str, description: &str, ) -> 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 folder
• name - Name for the created folder
• description - Description for created folder

pub unsafe fn create_folder_unsafe( &self, parent: Option<&ProjectFolder>, name: &str, description: &str, id: &str, ) -> 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 folder
• name - Name for the created folder
• description - Description for created folder
• id - id unique ID

pub fn folders(&self) -> Result<Array<ProjectFolder>, ()>

Get a list of folders in the project

pub fn folder_by_id(&self, id: &str) -> Option<Ref<ProjectFolder>>

Retrieve a folder in the project by unique folder id

pub fn delete_folder(&self, folder: &ProjectFolder) -> Result<(), ()>

Recursively delete a ProjectFolder from the Project.

• folder - ProjectFolder to delete recursively

pub fn delete_folder_with_progress<PC: ProgressCallback>( &self, folder: &ProjectFolder, progress: PC, ) -> Result<(), ()>

Recursively delete a ProjectFolder from the Project.

• folder - ProjectFolder to delete recursively
• progress - ProgressCallback that will be called as objects get deleted

pub fn push_file(&self, file: &ProjectFile)

pub fn create_file_from_path( &self, path: &str, folder: Option<&ProjectFolder>, name: &str, description: &str, ) -> Result<Ref<ProjectFile>, ()>

Create a file in the project from a path on disk

• path - Path on disk
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file

pub fn create_file_from_path_with_progress<PC>( &self, path: &str, folder: Option<&ProjectFolder>, name: &str, description: &str, progress: PC, ) -> Result<Ref<ProjectFile>, ()>

where PC: ProgressCallback,

Create a file in the project from a path on disk

• path - Path on disk
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file
• progress - ProgressCallback that will be called as the ProjectFile is being added

pub unsafe fn create_file_from_path_unsafe( &self, path: &str, folder: Option<&ProjectFolder>, name: &str, description: &str, id: &str, creation_time: SystemTime, ) -> Result<Ref<ProjectFile>, ()>

Create a file in the project from a path on disk

• path - Path on disk
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file
• id - id unique ID
• creation_time - Creation time of the file

pub unsafe fn create_file_from_path_unsafe_with_progress<PC>( &self, path: &str, folder: Option<&ProjectFolder>, name: &str, description: &str, id: &str, creation_time: SystemTime, progress: PC, ) -> Result<Ref<ProjectFile>, ()>

where PC: ProgressCallback,

Create a file in the project from a path on disk

• path - Path on disk
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file
• id - id unique ID
• creation_time - Creation time of the file
• progress - ProgressCallback that will be called as the ProjectFile is being created

pub fn create_file( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: &str, description: &str, ) -> Result<Ref<ProjectFile>, ()>

Create a file in the project

• contents - Bytes of the file that will be created
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file

pub fn create_file_with_progress<PC>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: &str, description: &str, progress: PC, ) -> Result<Ref<ProjectFile>, ()>

where PC: ProgressCallback,

Create a file in the project

• contents - Bytes of the file that will be created
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file
• progress - ProgressCallback that will be called as the ProjectFile is being created

pub unsafe fn create_file_unsafe( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: &str, description: &str, id: &str, creation_time: SystemTime, ) -> Result<Ref<ProjectFile>, ()>

Create a file in the project

• contents - Bytes of the file that will be created
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file
• id - id unique ID
• creation_time - Creation time of the file

pub unsafe fn create_file_unsafe_with_progress<PC>( &self, contents: &[u8], folder: Option<&ProjectFolder>, name: &str, description: &str, id: &str, creation_time: SystemTime, progress: PC, ) -> Result<Ref<ProjectFile>, ()>

where PC: ProgressCallback,

Create a file in the project

• contents - Bytes of the file that will be created
• folder - Folder to place the created file in
• name - Name to assign to the created file
• description - Description to assign to the created file
• id - id unique ID
• creation_time - Creation time of the file
• progress - ProgressCallback that will be called as the ProjectFile is being created

pub fn files(&self) -> Array<ProjectFile>

Get a list of files in the project

pub fn file_by_id(&self, id: &str) -> Option<Ref<ProjectFile>>

Retrieve a file in the project by unique id

pub fn file_by_path(&self, path: &str) -> Option<Ref<ProjectFile>>

Retrieve a file in the project by the path on disk

pub fn delete_file(&self, file: &ProjectFile) -> bool

Delete a file from the project

Trait Implementations

impl Deref for ProjectBulkOperationLock<'_>

type Target = Project

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for ProjectBulkOperationLock<'_>

fn drop(&mut self)

Executes the destructor for this type.