pub struct ShellCommand { /* private fields */ }Expand description
A parsed script plus its settings (Bun’s ShellPromise). Nothing runs
until ShellCommand::run is awaited.
Implementations§
Source§impl ShellCommand
impl ShellCommand
Sourcepub fn cwd(self, cwd: impl Into<PathBuf>) -> Self
pub fn cwd(self, cwd: impl Into<PathBuf>) -> Self
Working directory ("", "." and "./" mean the process cwd).
Sourcepub fn env(self, env: HashMap<String, String>) -> Self
pub fn env(self, env: HashMap<String, String>) -> Self
Replace the environment (Bun’s .env({...})).
Sourcepub fn prefer_local(self, preference: PreferLocal) -> Self
pub fn prefer_local(self, preference: PreferLocal) -> Self
Prefer project-local executables (a command-stream extension).
Sourcepub fn quiet(self) -> Self
pub fn quiet(self) -> Self
Capture output only, without echoing it to the process stdout/stderr.
pub fn throws(self, throws: bool) -> Self
Sourcepub async fn run(self) -> Result<ShellOutput, ShellError>
pub async fn run(self) -> Result<ShellOutput, ShellError>
Run the script to completion.
Sourcepub async fn text(self) -> Result<String, ShellError>
pub async fn text(self) -> Result<String, ShellError>
Run quietly and return stdout as text.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for ShellCommand
impl RefUnwindSafe for ShellCommand
impl Send for ShellCommand
impl Sync for ShellCommand
impl Unpin for ShellCommand
impl UnsafeUnpin for ShellCommand
impl UnwindSafe for ShellCommand
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more