Enum DocCommands

pub enum DocCommands {
    Switch {
        id: NamespaceId,
    },
    Create {
        switch: bool,
    },
    Join {
        ticket: DocTicket,
        switch: bool,
    },
    List,
    Share {
        doc: Option<NamespaceId>,
        mode: ShareMode,
        addr_options: AddrInfoOptions,
    },
    Set {
        doc: Option<NamespaceId>,
        author: Option<AuthorId>,
        key: String,
        value: String,
    },
    DlPolicy(DlPolicyCmd),
    Get {
        doc: Option<NamespaceId>,
        key: String,
        prefix: bool,
        author: Option<AuthorId>,
        mode: DisplayContentMode,
    },
    Del {
        doc: Option<NamespaceId>,
        author: Option<AuthorId>,
        prefix: String,
    },
    Keys {
        doc: Option<NamespaceId>,
        author: Option<AuthorId>,
        prefix: Option<String>,
        sort: Sorting,
        desc: bool,
        mode: DisplayContentMode,
    },
    Import {
        doc: Option<NamespaceId>,
        author: Option<AuthorId>,
        prefix: Option<String>,
        path: String,
        in_place: bool,
        no_prompt: bool,
    },
    Export {
        doc: Option<NamespaceId>,
        key: String,
        out: String,
    },
    Watch {
        doc: Option<NamespaceId>,
    },
    Leave {
        doc: Option<NamespaceId>,
    },
    Drop {
        doc: Option<NamespaceId>,
    },
}

Available on crate feature cli only.

Possible Document commands.

Variants

Switch

Set the active document (only works within the Iroh console).

Fields

id: NamespaceId

Create

Create a new document.

Fields

switch: bool

Switch to the created document (only in the Iroh console).

Join

Join a document from a ticket.

Fields

ticket: DocTicket

switch: bool

Switch to the joined document (only in the Iroh console).

List

List documents.

Share

Share a document with peers.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

mode: ShareMode

The sharing mode.

addr_options: AddrInfoOptions

Options to configure the address information in the generated ticket.

Use relay-and-addresses in networks with no internet connectivity.

Set

Set an entry in a document.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

author: Option<AuthorId>

Author of the entry.

Required unless the author is set through the IROH_AUTHOR environment variable. Within the Iroh console, the active author can also set with author switch.

key: String

Key to the entry (parsed as UTF-8 string).

value: String

Content to store for this entry (parsed as UTF-8 string)

DlPolicy(DlPolicyCmd)

Set the download policies for a document.

Get

Get entries in a document.

Shows the author, content hash and content length for all entries for this key.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

key: String

Key to the entry (parsed as UTF-8 string).

prefix: bool

If true, get all entries that start with KEY.

author: Option<AuthorId>

Filter by author.

mode: DisplayContentMode

How to show the contents of the key.

Del

Delete all entries below a key prefix.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

author: Option<AuthorId>

Author of the entry.

Required unless the author is set through the IROH_AUTHOR environment variable. Within the Iroh console, the active author can also set with author switch.

prefix: String

Prefix to delete. All entries whose key starts with or is equal to the prefix will be deleted.

Keys

List all keys in a document.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

author: Option<AuthorId>

Filter by author.

prefix: Option<String>

Optional key prefix (parsed as UTF-8 string)

sort: Sorting

How to sort the entries

desc: bool

Sort in descending order

mode: DisplayContentMode

How to show the contents of the keys.

Import

Import data into a document

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also be set with doc switch.

author: Option<AuthorId>

Author of the entry.

Required unless the author is set through the IROH_AUTHOR environment variable. Within the Iroh console, the active author can also be set with author switch.

prefix: Option<String>

Prefix to add to imported entries (parsed as UTF-8 string). Defaults to no prefix

path: String

Path to a local file or directory to import

Pathnames will be used as the document key

in_place: bool

If true, don’t copy the file into iroh, reference the existing file instead

Moving a file imported with in-place will result in data corruption

no_prompt: bool

When true, you will not get a prompt to confirm you want to import the files

Export

Export the most recent data for a key from a document

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also be set with doc switch.

key: String

Key to the entry (parsed as UTF-8 string)

When just the key is present, will export the latest entry for that key.

out: String

Path to export to

Watch

Watch for changes and events on a document

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

Leave

Stop syncing a document.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

Drop

Delete a document from the local node.

This is a destructive operation. Both the document secret key and all entries in the document will be permanently deleted from the node’s storage. Content blobs will be deleted through garbage collection unless they are referenced from another document or tag.

Fields

doc: Option<NamespaceId>

Document to operate on.

Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with doc switch.

Implementations

impl DocCommands

pub async fn run( self, docs: &Client, blobs: &Client, env: &ConsoleEnv, ) -> Result<()>

Runs the document command given the iroh client and the console environment.

Trait Implementations

impl Clone for DocCommands

fn clone(&self) -> DocCommands

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for DocCommands

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for DocCommands

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

Formats the value using the given formatter.

impl FromArgMatches for DocCommands

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 DocCommands

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::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) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::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][Error::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 DocCommands

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

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand