Enum yy_boss::cli::input::VfsCommand

pub enum VfsCommand {
    MoveResource {
        resource_to_move: String,
        resource: Resource,
        new_parent: ViewPath,
    },
    CreateFolder {
        parent_folder: ViewPathLocation,
        folder_name: String,
    },
    MoveFolder {
        folder: ViewPathLocation,
        new_parent: ViewPathLocation,
    },
    RemoveFolder {
        folder: ViewPathLocation,
        recursive: bool,
    },
    RenameFolder {
        folder: ViewPathLocation,
        new_name: String,
    },
    GetFolder {
        folder: ViewPathLocation,
    },
    GetFullVfs,
    GetPathType {
        path: ViewPath,
    },
}

The Virtual File System command type to run.

Variants

MoveResource

An instruction to move a Resource from one location to another.

Errors

If the resource_to_move field is not set to a valid resource, or if new_parent is not set to a valid folder, this command aborts and returns an error.

Fields of MoveResource

resource_to_move: String

The name of the Resource to move.

resource: Resource

The kind of the Resource to move.

new_parent: ViewPath

The new parent of the Resource, which must be a folder.

CreateFolder

An instruction to create a Folder under the specified folder path.

Errors

If the parent_folder field is not set to a valid folder, or if folder_name is not a unique child of parent_folder, this command aborts and returns an error.

Fields of CreateFolder

parent_folder: ViewPathLocation

The identity of the Parent to add a folder to.

folder_name: String

The name of the new folder to create.

MoveFolder

An instruction to move a Folder from one location to another, along with the resources within it.

Errors

If the folder_to_move or new_parent fields are not set to a valid folder, this command aborts and returns an error. If new_parent is a folder within folder_to_move, this command will abort and return a error.

Fields of MoveFolder

folder: ViewPathLocation

The location of the Resource to move.

new_parent: ViewPathLocation

The new parent of the Resource, which must be a folder.

RemoveFolder

Deletes a folder.

If the folder is not empty, then the recursive flag must be passed -- otherwise, this command will abort.

Fields of RemoveFolder

folder: ViewPathLocation

The location of the Folder to remove.

recursive: bool

If the folder is not empty, and this flag is not set to true, then the command will abort with an error.

Since the YypBoss is modeled as a black box, there is no notion of "force" -- otherwise, this command is similar to rm -rf on Unix systems.

RenameFolder

Renames a folder.

Fields of RenameFolder

folder: ViewPathLocation

The location of the Folder to rename.

new_name: String

The new name of the Folder.

GetFolder

Returns a [FolderGraph] for this folder.

Errors

If the ViewPathLocation provided does not describe a valid Folder, this command aborts and returns an error.

Fields of GetFolder

folder: ViewPathLocation

GetFullVfs

Returns a [FolderGraph] for the entire Virtual File System. Please note, this can result in a fairly massive Json being sent back.

Errors

This command is infallible.

GetPathType

Returns an enum if the given ViewPath links to a Folder or a File.

Errors

If the ViewPath provided does not describe a valid Item, this command aborts and returns an error.

Fields of GetPathType

path: ViewPath

Trait Implementations

impl Clone for VfsCommand

pub fn clone(&self) -> VfsCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VfsCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VfsCommand

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for VfsCommand

impl PartialEq<VfsCommand> for VfsCommand

pub fn eq(&self, other: &VfsCommand) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &VfsCommand) -> bool

This method tests for !=.

impl Serialize for VfsCommand

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for VfsCommand

impl StructuralPartialEq for VfsCommand