pub struct Agent<PB: ProtocolBehavior> {
descriptor: AgentDescriptor<<<PB as ProtocolBehavior>::ProtocolTypes as ProtocolTypes>::PUTConfig>,
put: Box<dyn Put<PB>>,
}Expand description
An Agent holds a non-cloneable reference to a Stream.
Fields§
§descriptor: AgentDescriptor<<<PB as ProtocolBehavior>::ProtocolTypes as ProtocolTypes>::PUTConfig>§put: Box<dyn Put<PB>>Implementations§
Source§impl<PB: ProtocolBehavior> Agent<PB>
impl<PB: ProtocolBehavior> Agent<PB>
pub fn new( descriptor: AgentDescriptor<<PB::ProtocolTypes as ProtocolTypes>::PUTConfig>, put: Box<dyn Put<PB>>, ) -> Self
pub fn progress(&mut self) -> Result<(), Error>
pub fn reset(&mut self, new_name: AgentName) -> Result<(), Error>
Sourcepub fn shutdown(&mut self) -> String
pub fn shutdown(&mut self) -> String
Shut down the agent by consuming it and returning a string that summarizes the execution.
Sourcepub fn is_state_successful(&self) -> bool
pub fn is_state_successful(&self) -> bool
Checks whether the agent is in a good state.
Sourcepub fn is_reusable_with(
&self,
other: &AgentDescriptor<<PB::ProtocolTypes as ProtocolTypes>::PUTConfig>,
) -> bool
pub fn is_reusable_with( &self, other: &AgentDescriptor<<PB::ProtocolTypes as ProtocolTypes>::PUTConfig>, ) -> bool
Checks whether the agent is reusable with the descriptor.
pub const fn name(&self) -> AgentName
pub fn put(&self) -> &dyn Put<PB>
pub fn put_mut(&mut self) -> &mut dyn Put<PB>
Trait Implementations§
Source§impl<PB: ProtocolBehavior> Debug for Agent<PB>
impl<PB: ProtocolBehavior> Debug for Agent<PB>
Source§impl<PB: ProtocolBehavior> PartialEq for Agent<PB>
impl<PB: ProtocolBehavior> PartialEq for Agent<PB>
Source§impl<PB: ProtocolBehavior> Stream<PB> for Agent<PB>
impl<PB: ProtocolBehavior> Stream<PB> for Agent<PB>
fn add_to_inbound(&mut self, message: &ConcreteMessage)
Source§fn take_message_from_outbound(
&mut self,
output_flight: &mut Option<PB::OpaqueProtocolMessageFlight>,
) -> Result<(), Error>
fn take_message_from_outbound( &mut self, output_flight: &mut Option<PB::OpaqueProtocolMessageFlight>, ) -> Result<(), Error>
Auto Trait Implementations§
impl<PB> Freeze for Agent<PB>
impl<PB> !RefUnwindSafe for Agent<PB>
impl<PB> !Send for Agent<PB>
impl<PB> !Sync for Agent<PB>
impl<PB> Unpin for Agent<PB>
impl<PB> !UnwindSafe for Agent<PB>
Blanket Implementations§
§impl<Head, T> Append<T> for Head
impl<Head, T> Append<T> for Head
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
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§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.§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);