NetworkRef

Struct NetworkRef 

Source
pub struct NetworkRef<'a> { /* private fields */ }
Expand description

Reference to a specific network.

Implementations§

Source§

impl<'a> NetworkRef<'a>

Source

pub fn id(&self) -> &str

Get the network ID.

Source

pub async fn inspect(&self) -> Result<Network>

Inspect the network to get detailed information.

Source

pub async fn connect(&self, container: impl Into<String>) -> Result<()>

Connect a container to this network.

§Example
use docker_client::DockerClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = DockerClient::new()?;
    client.networks()
        .get("my-network")
        .connect("my-container")
        .await?;
    Ok(())
}
Source

pub async fn disconnect( &self, container: impl Into<String>, force: bool, ) -> Result<()>

Disconnect a container from this network.

Source

pub async fn remove(&self) -> Result<()>

Remove the network.

Auto Trait Implementations§

§

impl<'a> Freeze for NetworkRef<'a>

§

impl<'a> !RefUnwindSafe for NetworkRef<'a>

§

impl<'a> Send for NetworkRef<'a>

§

impl<'a> Sync for NetworkRef<'a>

§

impl<'a> Unpin for NetworkRef<'a>

§

impl<'a> !UnwindSafe for NetworkRef<'a>

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

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

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