Struct Invocation 

pub struct Invocation {
    pub args: Vec<String>,
    pub concurrency: Concurrency,
    pub timeout: Duration,
    pub stdin: Option<Vec<u8>>,
}

One invocation of the CLI.

The argument list is a list. It is never joined into a string and never handed to a shell, which is what makes an argument containing a space, a quote or a semicolon uninteresting.

Fields

args: Vec<String>

concurrency: Concurrency

timeout: Duration

stdin: Option<Vec<u8>>

Bytes to write to the child’s standard input, for the few commands that read a document rather than a flag.

Implementations

impl Invocation

pub fn read<I, S>(args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

A read: overlaps freely, default timeout.

pub fn mutate<I, S>(args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

A mutation: queues behind other mutations.

pub fn mutate_shared<I, S>(args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

A mutation that cannot race the node’s configuration: it changes the filesystem, or a peer, but never what tailscale set and tailscale up contend over.

It runs in the shared lane because the lock exists to keep two configuration writes apart, and these are not that. Queueing them would buy no safety and cost a great deal: a ten-minute file transfer holding the exclusive lock stalls every concurrent read for its whole duration.

pub fn with_timeout(self, timeout: Duration) -> Self

pub fn with_stdin(self, stdin: impl Into<Vec<u8>>) -> Self

pub fn display(&self) -> String

The command as it would be written, for logs and error messages. Never used to run anything.

Trait Implementations

impl Clone for Invocation

fn clone(&self) -> Invocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invocation

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

Formats the value using the given formatter.