Struct docker_api::api::swarm::Swarm[−][src]

pub struct Swarm<'docker> { /* fields omitted */ }

This is supported on crate feature swarm only.

Expand description

Api Reference

Implementations

[src]

Inspect this Swarm.

[src]

pub async fn get_unlock_key(&self) -> Result<UnlockKey>

Api Reference

Get the unlock key.

[src]

pub async fn unlock_manager(&self, key: &UnlockKey) -> Result<()>

Api Reference

Unlock a locked manager.

[src]

pub async fn initialize(&self, opts: &SwarmInitOpts) -> Result<()>

Api Reference

Initialize a new swarm.

[src]

pub async fn join(&self, opts: &SwarmJoinOpts) -> Result<()>

Api Reference

Join an existing swarm.

[src]

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

Api Reference

Leave the current swarm.

[src]

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

Api Reference

Leave the current swarm forcefully, even if this is the last manager or that it will break the cluster.

Auto Trait Implementations

impl<'docker> !RefUnwindSafe for Swarm<'docker>

impl<'docker> Send for Swarm<'docker>

impl<'docker> Sync for Swarm<'docker>

impl<'docker> Unpin for Swarm<'docker>

impl<'docker> !UnwindSafe for Swarm<'docker>

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

Struct docker_api::api::swarm::Swarm[−][src]

Implementations

impl<'docker> Swarm<'docker>

pub fn new(docker: &'docker Docker) -> Self

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

pub async fn get_unlock_key(&self) -> Result<UnlockKey>

pub async fn unlock_manager(&self, key: &UnlockKey) -> Result<()>

pub async fn initialize(&self, opts: &SwarmInitOpts) -> Result<()>

pub async fn join(&self, opts: &SwarmJoinOpts) -> Result<()>

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

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

Auto Trait Implementations

impl<'docker> !RefUnwindSafe for Swarm<'docker>

impl<'docker> Send for Swarm<'docker>

impl<'docker> Sync for Swarm<'docker>

impl<'docker> Unpin for Swarm<'docker>

impl<'docker> !UnwindSafe for Swarm<'docker>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub 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>,

pub fn into(self) -> U

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

type Error = Infallible

pub 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

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

Struct docker_api::api::swarm::Swarm[−][src]

Implementations

impl<'docker> Swarm<'docker>

pub fn new(docker: &'docker Docker) -> Self

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

pub async fn get_unlock_key(&self) -> Result<UnlockKey>

pub async fn unlock_manager(&self, key: &UnlockKey) -> Result<()>

pub async fn initialize(&self, opts: &SwarmInitOpts) -> Result<()>

pub async fn join(&self, opts: &SwarmJoinOpts) -> Result<()>

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

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

Auto Trait Implementations

impl<'docker> !RefUnwindSafe for Swarm<'docker>

impl<'docker> Send for Swarm<'docker>

impl<'docker> Sync for Swarm<'docker>

impl<'docker> Unpin for Swarm<'docker>

impl<'docker> !UnwindSafe for Swarm<'docker>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub 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>,

pub fn into(self) -> U

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

type Error = Infallible

pub 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

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

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

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>,