Struct distant_core::DistantManagerClient

source · [−]

pub struct DistantManagerClient { /* private fields */ }

Expand description

Represents a client that can connect to a remote distant manager

Implementations

impl DistantManagerClient

pub fn new<T>(config: DistantManagerClientConfig, transport: T) -> Result<Self> where
    T: IntoSplit + 'static,
    T::Read: UntypedTransportRead + 'static,
    T::Write: UntypedTransportWrite + 'static,

Initializes a client using the provided [UntypedTransport]

pub async fn launch(
    &mut self,
    destination: impl Into<Destination>,
    options: impl Into<Map>
) -> Result<Destination>

Request that the manager launches a new server at the given destination with options being passed for destination-specific details, returning the new destination of the spawned server to connect to

pub async fn connect(
    &mut self,
    destination: impl Into<Destination>,
    options: impl Into<Map>
) -> Result<ConnectionId>

Request that the manager establishes a new connection at the given destination with options being passed for destination-specific details

pub async fn open_channel(
&mut self,
connection_id: ConnectionId
) -> Result<DistantChannel>

Establishes a channel with the server represented by the connection_id, returning a DistantChannel acting as the connection

Note

Multiple calls to open a channel against the same connection will result in clones of the same DistantChannel rather than establishing a duplicate remote connection to the same server

pub async fn open_raw_channel(
&mut self,
connection_id: ConnectionId
) -> Result<RawDistantChannel>

Establishes a channel with the server represented by the connection_id, returning a [Transport] acting as the connection

Note

Multiple calls to open a channel against the same connection will result in establishing a duplicate remote connections to the same server, so take care when using this method

pub async fn capabilities(&mut self) -> Result<ManagerCapabilities>

Retrieves a list of supported capabilities

pub async fn info(&mut self, id: ConnectionId) -> Result<ConnectionInfo>

Retrieves information about a specific connection

pub async fn kill(&mut self, id: ConnectionId) -> Result<()>

Kills the specified connection

pub async fn list(&mut self) -> Result<ConnectionList>

Retrieves a list of active connections

pub async fn shutdown(&mut self) -> Result<()>

Requests that the manager shuts down

Trait Implementations

impl Drop for DistantManagerClient

fn drop(&mut self)

Executes the destructor for this type. Read more

impl TcpDistantManagerClientExt for DistantManagerClient

fn connect<'async_trait, C>(
    config: DistantManagerClientConfig,
    addr: SocketAddr,
    codec: C
) -> Pin<Box<dyn Future<Output = Result<DistantManagerClient>> + Send + 'async_trait>> where
    C: Codec + Send + 'static,
    C: 'async_trait,
    Self: 'async_trait,

Connect to a remote TCP server using the provided information

fn connect_timeout<'async_trait, C>(
    config: DistantManagerClientConfig,
    addr: SocketAddr,
    codec: C,
    duration: Duration
) -> Pin<Box<dyn Future<Output = Result<DistantManagerClient>> + Send + 'async_trait>> where
    C: Codec + Send + 'static,
    C: 'async_trait,
    Self: Send + 'async_trait,

Connect to a remote TCP server, timing out after duration has passed

impl UnixSocketDistantManagerClientExt for DistantManagerClient

fn connect<'async_trait, P, C>(
    config: DistantManagerClientConfig,
    path: P,
    codec: C
) -> Pin<Box<dyn Future<Output = Result<DistantManagerClient>> + Send + 'async_trait>> where
    P: AsRef<Path> + Send,
    C: Codec + Send + 'static,
    P: 'async_trait,
    C: 'async_trait,

Connect to a proxy unix socket

fn connect_timeout<'async_trait, P, C>(
    config: DistantManagerClientConfig,
    path: P,
    codec: C,
    duration: Duration
) -> Pin<Box<dyn Future<Output = Result<DistantManagerClient>> + Send + 'async_trait>> where
    P: AsRef<Path> + Send,
    C: Codec + Send + 'static,
    P: 'async_trait,
    C: 'async_trait,
    Self: Send + 'async_trait,

Connect to a proxy unix socket, timing out after duration has passed

Auto Trait Implementations

impl !RefUnwindSafe for DistantManagerClient

impl Send for DistantManagerClient

impl !Sync for DistantManagerClient

impl Unpin for DistantManagerClient

impl !UnwindSafe for DistantManagerClient

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

Converts reference to Any

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

Converts mutable reference to Any

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

Consumes and produces Box<dyn Any>

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more