Skip to main content

Registry

Struct Registry 

Source
pub struct Registry(/* private fields */);
Expand description

Shared registry of live connections and recent events, read by the TUI and, when a log file is configured, mirrored to disk as JSON lines for headless use.

Implementations§

Source§

impl Registry

Source

pub fn new() -> Self

Source

pub fn subscribe(&self) -> Receiver<Event>

Subscribes to every event from now on, as structured values rather than the formatted lines of Registry::recent_log. A subscriber that falls more than a few hundred events behind gets RecvError::Lagged and skips ahead.

Source

pub fn set_log_file(&self, path: PathBuf) -> Result<()>

Source

pub fn open( &self, label: impl Into<String>, protocol: Protocol, source: impl Into<String>, destination: impl Into<String>, ) -> ConnectionInfo

Register a new connection and emit its ConnectionOpened event. Returns a handle whose bytes_in/bytes_out counters the caller should update live.

Source

pub fn close(&self, info: &ConnectionInfo)

Source

pub fn info(&self, message: impl Into<String>)

Source

pub fn error(&self, message: impl Into<String>)

Source

pub fn live_connections(&self) -> Vec<ConnectionInfo>

Source

pub fn recent_log(&self) -> Vec<String>

Source

pub fn totals(&self) -> Totals

Trait Implementations§

Source§

impl Clone for Registry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for Registry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.