Enum shadow_drive_cli::command::drive::DriveCommand

pub enum DriveCommand {
    ShadowRpcAuth,
    CreateStorageAccount {
        name: String,
        size: Byte,
    },
    DeleteStorageAccount {
        storage_account: Pubkey,
    },
    CancelDeleteStorageAccount {
        storage_account: Pubkey,
    },
    ClaimStake {
        storage_account: Pubkey,
    },
    AddStorage {
        storage_account: Pubkey,
        size: Byte,
    },
    AddImmutableStorage {
        storage_account: Pubkey,
        size: Byte,
    },
    ReduceStorage {
        storage_account: Pubkey,
        size: Byte,
    },
    MakeStorageImmutable {
        storage_account: Pubkey,
    },
    GetStorageAccount {
        storage_account: Pubkey,
    },
    GetStorageAccounts {
        owner: Option<Pubkey>,
    },
    ListFiles {
        storage_account: Pubkey,
    },
    GetText {
        storage_account: Pubkey,
        filename: String,
    },
    GetObjectData {
        storage_account: Pubkey,
        file: String,
    },
    DeleteFile {
        storage_account: Pubkey,
        filename: String,
    },
    EditFile {
        storage_account: Pubkey,
        path: PathBuf,
    },
    StoreFiles {
        storage_account: Pubkey,
        files: Vec<PathBuf>,
    },
}

Variants

ShadowRpcAuth

CreateStorageAccount

Fields

name: String

Unique identifier for your storage account

size: Byte

File size string, accepts KB, MB, GB, e.g. “10MB”

Create an account on which to store data. Storage accounts can be globally, irreversibly marked immutable for a one-time fee. Otherwise, files can be added or deleted from them, and space rented indefinitely.

DeleteStorageAccount

Fields

storage_account: Pubkey

The account to delete

Queues a storage account for deletion. While the request is still enqueued and not yet carried out, a cancellation can be made (see cancel-delete-storage-account subcommand).

CancelDeleteStorageAccount

Fields

storage_account: Pubkey

The account for which to cancel deletion.

Cancels the deletion of a storage account enqueued for deletion.

ClaimStake

Fields

storage_account: Pubkey

The account whose stake to claim.

Redeem tokens afforded to a storage account after reducing storage capacity.

AddStorage

Fields

storage_account: Pubkey

Storage account to modify

size: Byte

File size string, accepts KB, MB, GB, e.g. “10MB”

Increase the capacity of a storage account.

AddImmutableStorage

Fields

storage_account: Pubkey

Storage account to modify

size: Byte

File size string, accepts KB, MB, GB, e.g. “10MB”

Increase the immutable storage capacity of a storage account.

ReduceStorage

Fields

storage_account: Pubkey

Storage account to modify

size: Byte

File size string, accepts KB, MB, GB, e.g. “10MB”

Reduce the capacity of a storage account.

MakeStorageImmutable

Fields

storage_account: Pubkey

Storage account to be marked immutable

Make a storage account immutable. This is irreversible.

GetStorageAccount

Fields

storage_account: Pubkey

Account whose metadata will be fetched.

Fetch the metadata pertaining to a storage account.

GetStorageAccounts

Fields

owner: Option<Pubkey>

Searches for storage accounts owned by this owner.

Fetch a list of storage accounts owned by a particular pubkey. If no owner is provided, the configured signer is used.

ListFiles

Fields

storage_account: Pubkey

Storage account whose files to list.

List all the files in a storage account.

GetText

Fields

storage_account: Pubkey

Storage account where the file is located.

filename: String

Name of the file to fetch

Get a file, assume it’s text, and print it.

GetObjectData

Fields

storage_account: Pubkey

Storage account where the file is located.

file: String

Name of the file to examine.

Get basic file object data from a storage account file.

DeleteFile

Fields

storage_account: Pubkey

Storage account where the file to delete is located.

filename: String

Name of the file to delete.

Delete a file from a storage account.

EditFile

Fields

storage_account: Pubkey

Storage account where the file to edit is located.

path: PathBuf

Path to the new version of the file. Must be the same name as the file you are editing.

Has to be the same name as a previously uploaded file

StoreFiles

Fields

storage_account: Pubkey

The storage account on which to upload the files

files: Vec<PathBuf>

A list of one or more filepaths, each of which is to be uploaded.

Upload one or more files to a storage account.

Implementations

impl DriveCommand

pub async fn process<T: Signer>( &self, signer: &T, client_signer: T, rpc_url: &str, skip_confirm: bool, auth: Option<String> ) -> Result<()>

Trait Implementations

impl CommandFactory for DriveCommand

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for DriveCommand

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

Formats the value using the given formatter.

impl FromArgMatches for DriveCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for DriveCommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for DriveCommand

fn augment_subcommands<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand