Skip to main content

WslInvoker

Struct WslInvoker 

Source
pub struct WslInvoker<'runner> { /* private fields */ }
Expand description

Runs wsl.exe, through whatever CommandRunner it was given.

Implementations§

Source§

impl<'runner> WslInvoker<'runner>

Source

pub fn new( runner: &'runner dyn CommandRunner, executable: &'runner WslExecutable, ) -> Self

Binds a runner and an executable.

Source

pub fn executable(&self) -> &WslExecutable

The executable it will launch.

Source

pub fn list(&self) -> Result<DistributionTable, WslError>

wsl.exe --list --verbose.

§Errors

WslError::Spawn when wsl.exe is not there — which on a Windows host without WSL is the honest answer — and WslError::CommandFailed when it ran and refused.

Source

pub fn exec(&self, command: LinuxCommand) -> Result<CommandOutput, WslError>

Runs one command inside a distribution.

Takes the command by value, which is not an accident: a ChildInput is deliberately not Clone, so moving it into the request is the only way to run it. That both prevents a credential from being duplicated on the heap by a stray clone() and keeps the artifact installer from copying a fifteen-megabyte archive on its way to the pipe.

A non-zero exit is returned as a CommandOutput, not as an error: several callers here treat “it said no” as information rather than as a failure.

§Errors

WslError::InvalidName before anything is launched; WslError::Spawn, WslError::SecretInCommandLine or WslError::ChildControl from the runner.

Source

pub fn exec_ok( &self, what: &'static str, command: LinuxCommand, ) -> Result<CommandOutput, WslError>

Runs one command and refuses anything but a clean exit.

§Errors

As WslInvoker::exec, plus WslError::CommandFailed when the Linux program exited non-zero, timed out, or was cancelled.

Trait Implementations§

Source§

impl<'runner> Clone for WslInvoker<'runner>

Source§

fn clone(&self) -> WslInvoker<'runner>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'runner> Copy for WslInvoker<'runner>

Source§

impl<'runner> Debug for WslInvoker<'runner>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'runner> !RefUnwindSafe for WslInvoker<'runner>

§

impl<'runner> !UnwindSafe for WslInvoker<'runner>

§

impl<'runner> Freeze for WslInvoker<'runner>

§

impl<'runner> Send for WslInvoker<'runner>

§

impl<'runner> Sync for WslInvoker<'runner>

§

impl<'runner> Unpin for WslInvoker<'runner>

§

impl<'runner> UnsafeUnpin for WslInvoker<'runner>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more