Skip to main content

ConnectionOptions

Struct ConnectionOptions 

Source
pub struct ConnectionOptions { /* private fields */ }
Expand description

Connection-specific configuration options that can override base host settings.

This struct defines optional connection parameters that can be specified per connection plugin name (e.g., “ssh”, “netconf”, “http”) to override the base connection settings defined at the host, group, or defaults level. Connection options are stored in a map keyed by connection plugin name and are applied during connection parameter resolution.

All fields are optional, allowing partial overrides. When resolving connection parameters, these options take precedence over base settings at the same hierarchy level (host, group, or defaults).

§Fields

  • hostname - Optional hostname or IP address override for this connection plugin name. When specified, overrides the base hostname for connections of this type.

  • port - Optional port number override for this connection plugin name. When specified, overrides the base port for connections of this type.

  • username - Optional username override for authentication. When specified, overrides the base username for connections of this type.

  • password - Optional password override for authentication. When specified, overrides the base password for connections of this type.

  • platform - Optional platform identifier override. When specified, overrides the base platform for connections of this type.

  • extras - Optional arbitrary JSON data for connection-specific configuration. Allows storing additional connection parameters that don’t fit the standard fields.

§Examples

let options = ConnectionOptions::builder()
    .port(830)
    .username("netconf_user")
    .build();

Implementations§

Source§

impl ConnectionOptions

Source

pub fn builder() -> ConnectionOptionsBuilder

Source

pub fn hostname(&self) -> Option<&str>

Source

pub fn port(&self) -> Option<u16>

Source

pub fn username(&self) -> Option<&str>

Source

pub fn password(&self) -> Option<&str>

Source

pub fn platform(&self) -> Option<&str>

Source

pub fn extras(&self) -> Option<&Extras>

Source

pub fn to_builder(&self) -> ConnectionOptionsBuilder

Converts this ConnectionOptions instance into a builder for modification.

This method creates a new ConnectionOptionsBuilder initialized with all the current values from this ConnectionOptions instance. This is useful when you need to create a modified copy of existing connection options while preserving most of the original configuration.

§Returns

Returns a ConnectionOptionsBuilder with all fields initialized to match the current ConnectionOptions instance. The builder can then be used to modify specific fields before calling build() to create a new ConnectionOptions instance.

§Examples
let options = ConnectionOptions::builder()
    .port(830)
    .username("netconf_user")
    .build();

let modified = options.to_builder()
    .port(831)
    .build();

assert_eq!(modified.port(), Some(831));

Trait Implementations§

Source§

impl Clone for ConnectionOptions

Source§

fn clone(&self) -> ConnectionOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ConnectionOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ConnectionOptions

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ConnectionOptions

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for ConnectionOptions

Source§

fn eq(&self, other: &ConnectionOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ConnectionOptions

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ConnectionOptions

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.