pub struct ContainerStop { /* private fields */ }Expand description
Stop a running container.
§Examples
use ironflow_ops_docker::containers::ContainerStop;
use ironflow_ops_docker::DockerClient;
use ironflow_core::operation::Operation;
let client = DockerClient::connect_local().unwrap();
let op = ContainerStop::new(&client, "my-container");
assert_eq!(op.kind(), "docker");Implementations§
Source§impl ContainerStop
impl ContainerStop
Sourcepub fn new(client: impl Into<DockerRef>, container: impl Into<String>) -> Self
pub fn new(client: impl Into<DockerRef>, container: impl Into<String>) -> Self
Create a new container-stop operation.
Sourcepub fn timeout(self, secs: i64) -> Self
pub fn timeout(self, secs: i64) -> Self
Set the timeout in seconds before killing the container.
Sourcepub async fn run(
&self,
_ctx: &OperationContext,
) -> Result<ContainerStopOutput, OperationError>
pub async fn run( &self, _ctx: &OperationContext, ) -> Result<ContainerStopOutput, OperationError>
Execute and return a typed result.
§Errors
Returns OperationError::External if the container does not exist.
Trait Implementations§
Source§impl Operation for ContainerStop
impl Operation for ContainerStop
Source§fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: &'life1 OperationContext,
) -> Pin<Box<dyn Future<Output = Result<Value, OperationError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: &'life1 OperationContext,
) -> Pin<Box<dyn Future<Output = Result<Value, OperationError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Execute the operation and return the result as JSON. Read more
Source§impl TypedOperation for ContainerStop
impl TypedOperation for ContainerStop
Source§type Output = ContainerStopOutput
type Output = ContainerStopOutput
The concrete output type that
Operation::execute produces.Auto Trait Implementations§
impl !RefUnwindSafe for ContainerStop
impl !UnwindSafe for ContainerStop
impl Freeze for ContainerStop
impl Send for ContainerStop
impl Sync for ContainerStop
impl Unpin for ContainerStop
impl UnsafeUnpin for ContainerStop
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