pub struct BlockHandler {
pub current_context_id: RefCell<OutgoingContextId>,
pub block_cache: RefCell<HashMap<IncomingEndpointContextId, ScopeContext>>,
pub incoming_sections_queue: RefCell<VecDeque<IncomingSection>>,
pub section_observers: RefCell<HashMap<(IncomingContextId, IncomingSectionIndex), Box<dyn FnMut(IncomingSection)>>>,
pub incoming_blocks_history: RefCell<RingMap<BlockId, BlockHistoryData>>,
}Fields§
§current_context_id: RefCell<OutgoingContextId>§block_cache: RefCell<HashMap<IncomingEndpointContextId, ScopeContext>>a map of active request scopes for incoming blocks
incoming_sections_queue: RefCell<VecDeque<IncomingSection>>a queue of incoming request scopes the scopes can be retrieved from the request_scopes map
section_observers: RefCell<HashMap<(IncomingContextId, IncomingSectionIndex), Box<dyn FnMut(IncomingSection)>>>a map of observers for incoming response blocks (by context_id + block_index) contains an observer callback and an optional queue of blocks if the response block is a multi-block stream
incoming_blocks_history: RefCell<RingMap<BlockId, BlockHistoryData>>history of all incoming blocks
Implementations§
Source§impl BlockHandler
impl BlockHandler
pub fn new() -> BlockHandler
Sourcepub fn add_block_to_history(
&self,
block: &DXBBlock,
original_socket_uuid: Option<ComInterfaceSocketUUID>,
)
pub fn add_block_to_history( &self, block: &DXBBlock, original_socket_uuid: Option<ComInterfaceSocketUUID>, )
Adds a block to the history of incoming blocks if the block is not already in the history returns true if the block was added and not already in the history
Sourcepub fn is_block_in_history(&self, block: &DXBBlock) -> bool
pub fn is_block_in_history(&self, block: &DXBBlock) -> bool
Checks if a block is already in the history
pub fn get_block_data_from_history( &self, block: &DXBBlock, ) -> Option<BlockHistoryData>
pub fn handle_incoming_block(&self, block: DXBBlock)
pub fn get_new_context_id(&self) -> OutgoingContextId
Sourcepub fn register_incoming_block_observer(
&self,
context_id: OutgoingContextId,
section_index: OutgoingSectionIndex,
) -> UnboundedReceiver<IncomingSection>
pub fn register_incoming_block_observer( &self, context_id: OutgoingContextId, section_index: OutgoingSectionIndex, ) -> UnboundedReceiver<IncomingSection>
Adds a new observer for incoming blocks with a specific scope id and block index Returns a receiver that can be awaited to get the incoming sections
Sourcepub async fn wait_for_incoming_response_block(
&self,
context_id: OutgoingContextId,
section_index: OutgoingSectionIndex,
) -> Option<IncomingSection>
pub async fn wait_for_incoming_response_block( &self, context_id: OutgoingContextId, section_index: OutgoingSectionIndex, ) -> Option<IncomingSection>
Waits for incoming response block with a specific scope id and block index
Trait Implementations§
Source§impl Debug for BlockHandler
impl Debug for BlockHandler
Auto Trait Implementations§
impl !Freeze for BlockHandler
impl !RefUnwindSafe for BlockHandler
impl !Send for BlockHandler
impl !Sync for BlockHandler
impl Unpin for BlockHandler
impl !UnwindSafe for BlockHandler
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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> 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);