Struct LogCorrelationState 

pub struct LogCorrelationState { /* private fields */ }

State for a LogCorrelation component.

Contains the log streams, scroll position, active stream index, and configuration for synchronized scrolling.

Implementations

impl LogCorrelationState

pub fn new() -> Self

Creates a new empty log correlation state.

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new();
assert_eq!(state.stream_count(), 0);
assert!(state.sync_scroll());

pub fn with_streams(self, streams: Vec<LogStream>) -> Self

Sets the initial streams (builder pattern).

Example

use envision::component::{LogCorrelationState, LogStream};

let state = LogCorrelationState::new()
    .with_streams(vec![
        LogStream::new("API"),
        LogStream::new("DB"),
    ]);
assert_eq!(state.stream_count(), 2);

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title (builder pattern).

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new()
    .with_title("Log Correlation");
assert_eq!(state.title(), Some("Log Correlation"));

pub fn with_sync_scroll(self, sync: bool) -> Self

Sets whether scrolling is synchronized (builder pattern).

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new()
    .with_sync_scroll(false);
assert!(!state.sync_scroll());

pub fn streams(&self) -> &[LogStream]

Returns all streams.

Example

use envision::component::{LogCorrelationState, LogStream};

let state = LogCorrelationState::new()
    .with_streams(vec![LogStream::new("API"), LogStream::new("DB")]);
assert_eq!(state.streams().len(), 2);
assert_eq!(state.streams()[0].name, "API");

pub fn stream_count(&self) -> usize

Returns the number of streams.

Example

use envision::component::{LogCorrelationState, LogStream};

let state = LogCorrelationState::new()
    .with_streams(vec![LogStream::new("A"), LogStream::new("B")]);
assert_eq!(state.stream_count(), 2);

pub fn active_stream(&self) -> usize

Returns the index of the active (focused) stream.

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new();
assert_eq!(state.active_stream(), 0);

pub fn sync_scroll(&self) -> bool

Returns whether synchronized scrolling is enabled.

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new();
assert!(state.sync_scroll()); // enabled by default

pub fn scroll_offset(&self) -> usize

Returns the scroll offset.

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new();
assert_eq!(state.scroll_offset(), 0);

pub fn scroll_timestamp(&self) -> f64

Returns the current scroll timestamp.

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new();
assert_eq!(state.scroll_timestamp(), 0.0);

pub fn title(&self) -> Option<&str>

Returns the title.

Example

use envision::component::LogCorrelationState;

let state = LogCorrelationState::new().with_title("Logs");
assert_eq!(state.title(), Some("Logs"));

let no_title = LogCorrelationState::new();
assert_eq!(no_title.title(), None);

pub fn set_title(&mut self, title: impl Into<String>)

Sets the title.

Example

use envision::component::LogCorrelationState;

let mut state = LogCorrelationState::new();
state.set_title("Correlated Logs");
assert_eq!(state.title(), Some("Correlated Logs"));

pub fn add_stream(&mut self, stream: LogStream)

Adds a new log stream.

Example

use envision::component::{LogCorrelationState, LogStream};

let mut state = LogCorrelationState::new();
state.add_stream(LogStream::new("API"));
assert_eq!(state.stream_count(), 1);

pub fn push_entry(&mut self, stream_idx: usize, entry: CorrelationEntry)

Pushes an entry to the specified stream.

Example

use envision::component::{
    LogCorrelationState, LogStream,
    CorrelationEntry, CorrelationLevel,
};

let mut state = LogCorrelationState::new()
    .with_streams(vec![LogStream::new("API")]);
state.push_entry(0, CorrelationEntry::new(1.0, CorrelationLevel::Info, "Hello"));
assert_eq!(state.streams()[0].entries.len(), 1);

pub fn update( &mut self, msg: LogCorrelationMessage, ) -> Option<LogCorrelationOutput>

Updates the state with a message, returning any output.

Example

use envision::component::{
    LogCorrelationState, LogCorrelationMessage, LogCorrelationOutput, LogStream,
};

let mut state = LogCorrelationState::new()
    .with_streams(vec![LogStream::new("A"), LogStream::new("B")]);
let output = state.update(LogCorrelationMessage::FocusNextStream);
assert_eq!(output, Some(LogCorrelationOutput::StreamFocused(1)));

Trait Implementations

impl Clone for LogCorrelationState

fn clone(&self) -> LogCorrelationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogCorrelationState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LogCorrelationState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LogCorrelationState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LogCorrelationState

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LogCorrelationState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.