#[non_exhaustive]pub struct RouteServerRouteBuilder { /* private fields */ }
Expand description
A builder for RouteServerRoute
.
Implementations§
Source§impl RouteServerRouteBuilder
impl RouteServerRouteBuilder
Sourcepub fn route_server_endpoint_id(self, input: impl Into<String>) -> Self
pub fn route_server_endpoint_id(self, input: impl Into<String>) -> Self
The ID of the route server endpoint that received this route.
Sourcepub fn set_route_server_endpoint_id(self, input: Option<String>) -> Self
pub fn set_route_server_endpoint_id(self, input: Option<String>) -> Self
The ID of the route server endpoint that received this route.
Sourcepub fn get_route_server_endpoint_id(&self) -> &Option<String>
pub fn get_route_server_endpoint_id(&self) -> &Option<String>
The ID of the route server endpoint that received this route.
Sourcepub fn route_server_peer_id(self, input: impl Into<String>) -> Self
pub fn route_server_peer_id(self, input: impl Into<String>) -> Self
The ID of the route server peer that advertised this route.
Sourcepub fn set_route_server_peer_id(self, input: Option<String>) -> Self
pub fn set_route_server_peer_id(self, input: Option<String>) -> Self
The ID of the route server peer that advertised this route.
Sourcepub fn get_route_server_peer_id(&self) -> &Option<String>
pub fn get_route_server_peer_id(&self) -> &Option<String>
The ID of the route server peer that advertised this route.
Sourcepub fn route_installation_details(
self,
input: RouteServerRouteInstallationDetail,
) -> Self
pub fn route_installation_details( self, input: RouteServerRouteInstallationDetail, ) -> Self
Appends an item to route_installation_details
.
To override the contents of this collection use set_route_installation_details
.
Details about the installation status of this route in route tables.
Sourcepub fn set_route_installation_details(
self,
input: Option<Vec<RouteServerRouteInstallationDetail>>,
) -> Self
pub fn set_route_installation_details( self, input: Option<Vec<RouteServerRouteInstallationDetail>>, ) -> Self
Details about the installation status of this route in route tables.
Sourcepub fn get_route_installation_details(
&self,
) -> &Option<Vec<RouteServerRouteInstallationDetail>>
pub fn get_route_installation_details( &self, ) -> &Option<Vec<RouteServerRouteInstallationDetail>>
Details about the installation status of this route in route tables.
Sourcepub fn route_status(self, input: RouteServerRouteStatus) -> Self
pub fn route_status(self, input: RouteServerRouteStatus) -> Self
The current status of the route in the routing database. Values are in-rib
or in-fib
depending on if the routes are in the RIB or the FIB database.
The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.
The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.
Sourcepub fn set_route_status(self, input: Option<RouteServerRouteStatus>) -> Self
pub fn set_route_status(self, input: Option<RouteServerRouteStatus>) -> Self
The current status of the route in the routing database. Values are in-rib
or in-fib
depending on if the routes are in the RIB or the FIB database.
The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.
The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.
Sourcepub fn get_route_status(&self) -> &Option<RouteServerRouteStatus>
pub fn get_route_status(&self) -> &Option<RouteServerRouteStatus>
The current status of the route in the routing database. Values are in-rib
or in-fib
depending on if the routes are in the RIB or the FIB database.
The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.
The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.
Sourcepub fn set_prefix(self, input: Option<String>) -> Self
pub fn set_prefix(self, input: Option<String>) -> Self
The destination CIDR block of the route.
Sourcepub fn get_prefix(&self) -> &Option<String>
pub fn get_prefix(&self) -> &Option<String>
The destination CIDR block of the route.
Sourcepub fn as_paths(self, input: impl Into<String>) -> Self
pub fn as_paths(self, input: impl Into<String>) -> Self
Appends an item to as_paths
.
To override the contents of this collection use set_as_paths
.
The AS path attributes of the BGP route.
Sourcepub fn set_as_paths(self, input: Option<Vec<String>>) -> Self
pub fn set_as_paths(self, input: Option<Vec<String>>) -> Self
The AS path attributes of the BGP route.
Sourcepub fn get_as_paths(&self) -> &Option<Vec<String>>
pub fn get_as_paths(&self) -> &Option<Vec<String>>
The AS path attributes of the BGP route.
Sourcepub fn med(self, input: i32) -> Self
pub fn med(self, input: i32) -> Self
The Multi-Exit Discriminator (MED) value of the BGP route.
Sourcepub fn set_med(self, input: Option<i32>) -> Self
pub fn set_med(self, input: Option<i32>) -> Self
The Multi-Exit Discriminator (MED) value of the BGP route.
Sourcepub fn get_med(&self) -> &Option<i32>
pub fn get_med(&self) -> &Option<i32>
The Multi-Exit Discriminator (MED) value of the BGP route.
Sourcepub fn next_hop_ip(self, input: impl Into<String>) -> Self
pub fn next_hop_ip(self, input: impl Into<String>) -> Self
The IP address for the next hop.
Sourcepub fn set_next_hop_ip(self, input: Option<String>) -> Self
pub fn set_next_hop_ip(self, input: Option<String>) -> Self
The IP address for the next hop.
Sourcepub fn get_next_hop_ip(&self) -> &Option<String>
pub fn get_next_hop_ip(&self) -> &Option<String>
The IP address for the next hop.
Sourcepub fn build(self) -> RouteServerRoute
pub fn build(self) -> RouteServerRoute
Consumes the builder and constructs a RouteServerRoute
.
Trait Implementations§
Source§impl Clone for RouteServerRouteBuilder
impl Clone for RouteServerRouteBuilder
Source§fn clone(&self) -> RouteServerRouteBuilder
fn clone(&self) -> RouteServerRouteBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RouteServerRouteBuilder
impl Debug for RouteServerRouteBuilder
Source§impl Default for RouteServerRouteBuilder
impl Default for RouteServerRouteBuilder
Source§fn default() -> RouteServerRouteBuilder
fn default() -> RouteServerRouteBuilder
Source§impl PartialEq for RouteServerRouteBuilder
impl PartialEq for RouteServerRouteBuilder
impl StructuralPartialEq for RouteServerRouteBuilder
Auto Trait Implementations§
impl Freeze for RouteServerRouteBuilder
impl RefUnwindSafe for RouteServerRouteBuilder
impl Send for RouteServerRouteBuilder
impl Sync for RouteServerRouteBuilder
impl Unpin for RouteServerRouteBuilder
impl UnwindSafe for RouteServerRouteBuilder
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§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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);