Struct distant_core::RemoteCommand

source · [−]

pub struct RemoteCommand { /* private fields */ }

Expand description

A RemoteProcess builder providing support to configure before spawning the process on a remote machine

Implementations

source

impl RemoteCommand

source

pub fn new() -> Self

Creates a new set of options for a remote process

source

pub fn persist(&mut self, persist: bool) -> &mut Self

Sets whether or not the process will be persistent, meaning that it will not be terminated when the connection to the remote machine is terminated

source

pub fn pty(&mut self, pty: Option<PtySize>) -> &mut Self

Configures the process to leverage a PTY with the specified size

source

pub fn environment(&mut self, environment: Environment) -> &mut Self

Replaces the existing environment variables with the given collection

source

pub fn current_dir(&mut self, current_dir: Option<PathBuf>) -> &mut Self

Configures the process with an alternative current directory

source

pub async fn spawn(
 &mut self,
 channel: DistantChannel,
 cmd: impl Into<String>
) -> Result<RemoteProcess>

Spawns the specified process on the remote machine using the given channel and cmd

Trait Implementations

source

impl Default for RemoteCommand

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for RemoteCommand

impl Send for RemoteCommand

impl Sync for RemoteCommand

impl Unpin for RemoteCommand

impl UnwindSafe for RemoteCommand

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> AsAny for T where
T: 'static,

source

fn as_any(&self) -> &(dyn Any + 'static)

Converts reference to Any

source

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Converts mutable reference to Any

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Consumes and produces Box<dyn Any>

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

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

Struct distant_core::RemoteCommand

Implementations

impl RemoteCommand

pub fn new() -> Self

pub fn persist(&mut self, persist: bool) -> &mut Self

pub fn pty(&mut self, pty: Option<PtySize>) -> &mut Self

pub fn environment(&mut self, environment: Environment) -> &mut Self

pub fn current_dir(&mut self, current_dir: Option<PathBuf>) -> &mut Self

pub async fn spawn( &mut self, channel: DistantChannel, cmd: impl Into<String>) -> Result<RemoteProcess>

Trait Implementations

impl Default for RemoteCommand

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for RemoteCommand

impl Send for RemoteCommand

impl Sync for RemoteCommand

impl Unpin for RemoteCommand

impl UnwindSafe for RemoteCommand

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: 'static,

fn as_any(&self) -> &(dyn Any + 'static)

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn spawn(
&mut self,
channel: DistantChannel,
cmd: impl Into<String>
) -> Result<RemoteProcess>

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

impl<T> AsAny for T where
T: 'static,

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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