#[non_exhaustive]pub struct BgpPeerBuilder { /* private fields */ }Expand description
A builder for BgpPeer.
Implementations§
Source§impl BgpPeerBuilder
impl BgpPeerBuilder
Sourcepub fn bgp_peer_id(self, input: impl Into<String>) -> Self
pub fn bgp_peer_id(self, input: impl Into<String>) -> Self
The ID of the BGP peer.
Sourcepub fn set_bgp_peer_id(self, input: Option<String>) -> Self
pub fn set_bgp_peer_id(self, input: Option<String>) -> Self
The ID of the BGP peer.
Sourcepub fn get_bgp_peer_id(&self) -> &Option<String>
pub fn get_bgp_peer_id(&self) -> &Option<String>
The ID of the BGP peer.
Sourcepub fn asn(self, input: i32) -> Self
pub fn asn(self, input: i32) -> Self
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Sourcepub fn set_asn(self, input: Option<i32>) -> Self
pub fn set_asn(self, input: Option<i32>) -> Self
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Sourcepub fn get_asn(&self) -> &Option<i32>
pub fn get_asn(&self) -> &Option<i32>
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Sourcepub fn auth_key(self, input: impl Into<String>) -> Self
pub fn auth_key(self, input: impl Into<String>) -> Self
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Sourcepub fn set_auth_key(self, input: Option<String>) -> Self
pub fn set_auth_key(self, input: Option<String>) -> Self
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Sourcepub fn get_auth_key(&self) -> &Option<String>
pub fn get_auth_key(&self) -> &Option<String>
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Sourcepub fn address_family(self, input: AddressFamily) -> Self
pub fn address_family(self, input: AddressFamily) -> Self
The address family for the BGP peer.
Sourcepub fn set_address_family(self, input: Option<AddressFamily>) -> Self
pub fn set_address_family(self, input: Option<AddressFamily>) -> Self
The address family for the BGP peer.
Sourcepub fn get_address_family(&self) -> &Option<AddressFamily>
pub fn get_address_family(&self) -> &Option<AddressFamily>
The address family for the BGP peer.
Sourcepub fn amazon_address(self, input: impl Into<String>) -> Self
pub fn amazon_address(self, input: impl Into<String>) -> Self
The IP address assigned to the Amazon interface.
Sourcepub fn set_amazon_address(self, input: Option<String>) -> Self
pub fn set_amazon_address(self, input: Option<String>) -> Self
The IP address assigned to the Amazon interface.
Sourcepub fn get_amazon_address(&self) -> &Option<String>
pub fn get_amazon_address(&self) -> &Option<String>
The IP address assigned to the Amazon interface.
Sourcepub fn customer_address(self, input: impl Into<String>) -> Self
pub fn customer_address(self, input: impl Into<String>) -> Self
The IP address assigned to the customer interface.
Sourcepub fn set_customer_address(self, input: Option<String>) -> Self
pub fn set_customer_address(self, input: Option<String>) -> Self
The IP address assigned to the customer interface.
Sourcepub fn get_customer_address(&self) -> &Option<String>
pub fn get_customer_address(&self) -> &Option<String>
The IP address assigned to the customer interface.
Sourcepub fn bgp_peer_state(self, input: BgpPeerState) -> Self
pub fn bgp_peer_state(self, input: BgpPeerState) -> Self
The state of the BGP peer. The following are the possible values:
-
verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces. -
pending: The BGP peer is created, and remains in this state until it is ready to be established. -
available: The BGP peer is ready to be established. -
deleting: The BGP peer is being deleted. -
deleted: The BGP peer is deleted and cannot be established.
Sourcepub fn set_bgp_peer_state(self, input: Option<BgpPeerState>) -> Self
pub fn set_bgp_peer_state(self, input: Option<BgpPeerState>) -> Self
The state of the BGP peer. The following are the possible values:
-
verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces. -
pending: The BGP peer is created, and remains in this state until it is ready to be established. -
available: The BGP peer is ready to be established. -
deleting: The BGP peer is being deleted. -
deleted: The BGP peer is deleted and cannot be established.
Sourcepub fn get_bgp_peer_state(&self) -> &Option<BgpPeerState>
pub fn get_bgp_peer_state(&self) -> &Option<BgpPeerState>
The state of the BGP peer. The following are the possible values:
-
verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces. -
pending: The BGP peer is created, and remains in this state until it is ready to be established. -
available: The BGP peer is ready to be established. -
deleting: The BGP peer is being deleted. -
deleted: The BGP peer is deleted and cannot be established.
Sourcepub fn bgp_status(self, input: BgpStatus) -> Self
pub fn bgp_status(self, input: BgpStatus) -> Self
The status of the BGP peer. The following are the possible values:
-
up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session. -
down: The BGP peer is down. -
unknown: The BGP peer status is not available.
Sourcepub fn set_bgp_status(self, input: Option<BgpStatus>) -> Self
pub fn set_bgp_status(self, input: Option<BgpStatus>) -> Self
The status of the BGP peer. The following are the possible values:
-
up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session. -
down: The BGP peer is down. -
unknown: The BGP peer status is not available.
Sourcepub fn get_bgp_status(&self) -> &Option<BgpStatus>
pub fn get_bgp_status(&self) -> &Option<BgpStatus>
The status of the BGP peer. The following are the possible values:
-
up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session. -
down: The BGP peer is down. -
unknown: The BGP peer status is not available.
Sourcepub fn aws_device_v2(self, input: impl Into<String>) -> Self
pub fn aws_device_v2(self, input: impl Into<String>) -> Self
The Direct Connect endpoint that terminates the BGP peer.
Sourcepub fn set_aws_device_v2(self, input: Option<String>) -> Self
pub fn set_aws_device_v2(self, input: Option<String>) -> Self
The Direct Connect endpoint that terminates the BGP peer.
Sourcepub fn get_aws_device_v2(&self) -> &Option<String>
pub fn get_aws_device_v2(&self) -> &Option<String>
The Direct Connect endpoint that terminates the BGP peer.
Sourcepub fn aws_logical_device_id(self, input: impl Into<String>) -> Self
pub fn aws_logical_device_id(self, input: impl Into<String>) -> Self
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Sourcepub fn set_aws_logical_device_id(self, input: Option<String>) -> Self
pub fn set_aws_logical_device_id(self, input: Option<String>) -> Self
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Sourcepub fn get_aws_logical_device_id(&self) -> &Option<String>
pub fn get_aws_logical_device_id(&self) -> &Option<String>
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Trait Implementations§
Source§impl Clone for BgpPeerBuilder
impl Clone for BgpPeerBuilder
Source§fn clone(&self) -> BgpPeerBuilder
fn clone(&self) -> BgpPeerBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for BgpPeerBuilder
impl Debug for BgpPeerBuilder
Source§impl Default for BgpPeerBuilder
impl Default for BgpPeerBuilder
Source§fn default() -> BgpPeerBuilder
fn default() -> BgpPeerBuilder
Source§impl PartialEq for BgpPeerBuilder
impl PartialEq for BgpPeerBuilder
impl StructuralPartialEq for BgpPeerBuilder
Auto Trait Implementations§
impl Freeze for BgpPeerBuilder
impl RefUnwindSafe for BgpPeerBuilder
impl Send for BgpPeerBuilder
impl Sync for BgpPeerBuilder
impl Unpin for BgpPeerBuilder
impl UnwindSafe for BgpPeerBuilder
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);