Struct TransportConfigBuilder 

pub struct TransportConfigBuilder {
    protocols: Option<Vec<PtTransportName>>,
    path: Option<Option<CfgPath>>,
    arguments: Option<Vec<String>>,
    proxy_addr: Option<Option<SocketAddr>>,
    run_on_startup: Option<bool>,
}

A builder to create an instance of TransportConfig.

Fields

protocols: Option<Vec<PtTransportName>>

path: Option<Option<CfgPath>>

arguments: Option<Vec<String>>

proxy_addr: Option<Option<SocketAddr>>

run_on_startup: Option<bool>

Implementations

impl TransportConfigBuilder

pub fn protocols( &mut self, val: Vec<PtTransportName>, ) -> &mut TransportConfigBuilder

Provide a value for protocols.

If no value is provided for protocols, build will fail with an error.

protocols

Names of the transport protocols that we are willing to use from this transport.

(These protocols are arbitrary identifiers that describe which protocols we want. They must match names that the binary knows how to provide.)

pub fn path(&mut self, val: CfgPath) -> &mut TransportConfigBuilder

Provide a value for path.

If no value is provided for path, build will use Default::default(). For convenience, this function accepts both CfgPath and Option<$T> .

path

The path to the binary to run, if any.

This needs to be the path to some executable file on disk.

Present only for managed transports.

pub fn arguments(&mut self, val: Vec<String>) -> &mut TransportConfigBuilder

Provide a value for arguments.

If no value is provided for arguments, build will use Default::default().

arguments

One or more command-line arguments to pass to the binary.

Meaningful only for managed transports.

pub fn proxy_addr(&mut self, val: SocketAddr) -> &mut TransportConfigBuilder

Provide a value for proxy_addr.

If no value is provided for proxy_addr, build will use Default::default(). For convenience, this function accepts both SocketAddr and Option<$T> .

proxy_addr

The location at which to contact this transport.

Present only for unmanaged transports.

pub fn run_on_startup(&mut self, val: bool) -> &mut TransportConfigBuilder

Provide a value for run_on_startup.

If no value is provided for run_on_startup, build will use Default::default().

run_on_startup

If true, launch this transport on startup. Otherwise, we launch it on demand.

Meaningful only for managed transports.

impl TransportConfigBuilder

pub fn new() -> TransportConfigBuilder

Return a new builder object.

pub fn build(&self) -> Result<TransportConfig, ConfigBuildError>

Try to construct a new TransportConfig from the fields set in this builder.

Return an error if any required field is missing, or is set to something invalid.

impl TransportConfigBuilder

pub fn get_protocols(&self) -> &[PtTransportName]

Inspect the list of protocols (ie, transport names)

If none have yet been specified, returns an empty list.

Trait Implementations

impl Builder for TransportConfigBuilder

type Built = TransportConfig

The type that this builder constructs.

fn build(&self) -> Result<TransportConfig, ConfigBuildError>

Build into a Built

impl Clone for TransportConfigBuilder

fn clone(&self) -> TransportConfigBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransportConfigBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TransportConfigBuilder

fn default() -> TransportConfigBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransportConfigBuilder

fn deserialize<__D>( __deserializer: __D, ) -> Result<TransportConfigBuilder, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtendBuilder for TransportConfigBuilder

fn extend_from( &mut self, other: TransportConfigBuilder, strategy: ExtendStrategy, )

Consume other, and merge its contents into self.

impl Flattenable for TransportConfigBuilder

fn has_field(s: &str) -> bool

Does this type have a field named s ?

impl Serialize for TransportConfigBuilder

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.