#[non_exhaustive]pub struct OutboundConnectionBuilder { /* private fields */ }Expand description
A builder for OutboundConnection.
Implementations§
source§impl OutboundConnectionBuilder
impl OutboundConnectionBuilder
sourcepub fn local_domain_info(self, input: DomainInformationContainer) -> Self
pub fn local_domain_info(self, input: DomainInformationContainer) -> Self
Information about the source (local) domain.
sourcepub fn set_local_domain_info(
self,
input: Option<DomainInformationContainer>,
) -> Self
pub fn set_local_domain_info( self, input: Option<DomainInformationContainer>, ) -> Self
Information about the source (local) domain.
sourcepub fn get_local_domain_info(&self) -> &Option<DomainInformationContainer>
pub fn get_local_domain_info(&self) -> &Option<DomainInformationContainer>
Information about the source (local) domain.
sourcepub fn remote_domain_info(self, input: DomainInformationContainer) -> Self
pub fn remote_domain_info(self, input: DomainInformationContainer) -> Self
Information about the destination (remote) domain.
sourcepub fn set_remote_domain_info(
self,
input: Option<DomainInformationContainer>,
) -> Self
pub fn set_remote_domain_info( self, input: Option<DomainInformationContainer>, ) -> Self
Information about the destination (remote) domain.
sourcepub fn get_remote_domain_info(&self) -> &Option<DomainInformationContainer>
pub fn get_remote_domain_info(&self) -> &Option<DomainInformationContainer>
Information about the destination (remote) domain.
sourcepub fn connection_id(self, input: impl Into<String>) -> Self
pub fn connection_id(self, input: impl Into<String>) -> Self
Unique identifier of the connection.
sourcepub fn set_connection_id(self, input: Option<String>) -> Self
pub fn set_connection_id(self, input: Option<String>) -> Self
Unique identifier of the connection.
sourcepub fn get_connection_id(&self) -> &Option<String>
pub fn get_connection_id(&self) -> &Option<String>
Unique identifier of the connection.
sourcepub fn connection_alias(self, input: impl Into<String>) -> Self
pub fn connection_alias(self, input: impl Into<String>) -> Self
Name of the connection.
sourcepub fn set_connection_alias(self, input: Option<String>) -> Self
pub fn set_connection_alias(self, input: Option<String>) -> Self
Name of the connection.
sourcepub fn get_connection_alias(&self) -> &Option<String>
pub fn get_connection_alias(&self) -> &Option<String>
Name of the connection.
sourcepub fn connection_status(self, input: OutboundConnectionStatus) -> Self
pub fn connection_status(self, input: OutboundConnectionStatus) -> Self
Status of the connection.
sourcepub fn set_connection_status(
self,
input: Option<OutboundConnectionStatus>,
) -> Self
pub fn set_connection_status( self, input: Option<OutboundConnectionStatus>, ) -> Self
Status of the connection.
sourcepub fn get_connection_status(&self) -> &Option<OutboundConnectionStatus>
pub fn get_connection_status(&self) -> &Option<OutboundConnectionStatus>
Status of the connection.
sourcepub fn connection_mode(self, input: ConnectionMode) -> Self
pub fn connection_mode(self, input: ConnectionMode) -> Self
The connection mode.
sourcepub fn set_connection_mode(self, input: Option<ConnectionMode>) -> Self
pub fn set_connection_mode(self, input: Option<ConnectionMode>) -> Self
The connection mode.
sourcepub fn get_connection_mode(&self) -> &Option<ConnectionMode>
pub fn get_connection_mode(&self) -> &Option<ConnectionMode>
The connection mode.
sourcepub fn connection_properties(self, input: ConnectionProperties) -> Self
pub fn connection_properties(self, input: ConnectionProperties) -> Self
Properties for the outbound connection.
sourcepub fn set_connection_properties(
self,
input: Option<ConnectionProperties>,
) -> Self
pub fn set_connection_properties( self, input: Option<ConnectionProperties>, ) -> Self
Properties for the outbound connection.
sourcepub fn get_connection_properties(&self) -> &Option<ConnectionProperties>
pub fn get_connection_properties(&self) -> &Option<ConnectionProperties>
Properties for the outbound connection.
sourcepub fn build(self) -> OutboundConnection
pub fn build(self) -> OutboundConnection
Consumes the builder and constructs a OutboundConnection.
Trait Implementations§
source§impl Clone for OutboundConnectionBuilder
impl Clone for OutboundConnectionBuilder
source§fn clone(&self) -> OutboundConnectionBuilder
fn clone(&self) -> OutboundConnectionBuilder
1.6.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for OutboundConnectionBuilder
impl Debug for OutboundConnectionBuilder
source§impl Default for OutboundConnectionBuilder
impl Default for OutboundConnectionBuilder
source§fn default() -> OutboundConnectionBuilder
fn default() -> OutboundConnectionBuilder
impl StructuralPartialEq for OutboundConnectionBuilder
Auto Trait Implementations§
impl Freeze for OutboundConnectionBuilder
impl RefUnwindSafe for OutboundConnectionBuilder
impl Send for OutboundConnectionBuilder
impl Sync for OutboundConnectionBuilder
impl Unpin for OutboundConnectionBuilder
impl UnwindSafe for OutboundConnectionBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);