Connection

Struct Connection 

Source
pub struct Connection<S> { /* private fields */ }
Expand description

A connection in a specific state.

The type parameter S represents the current state of the connection. Different methods are available depending on the state.

Implementations§

Source§

impl Connection<Disconnected>

Source

pub fn new() -> Self

Create a new disconnected connection.

Source

pub fn id(&self) -> &str

Get the connection ID.

Source

pub fn connect(self) -> Connection<Connected>

Establish the connection (transition to Connected state).

In a real implementation, this would take a transport and establish the connection. Here we just transition the state.

Source§

impl Connection<Connected>

Source

pub fn id(&self) -> &str

Get the connection ID.

Source

pub const fn connected_at(&self) -> Option<Instant>

Get when the connection was established.

Source

pub fn uptime(&self) -> Duration

Get how long the connection has been active.

Source

pub fn initialize( self, client_info: ClientInfo, client_capabilities: ClientCapabilities, ) -> (Connection<Initializing>, InitializeRequest)

Begin initialization (transition to Initializing state).

For clients: Send initialize request with client info and capabilities. For servers: This is called when receiving an initialize request.

Source

pub fn disconnect(self) -> Connection<Disconnected>

Disconnect (transition back to Disconnected state).

Source§

impl Connection<Initializing>

Source

pub fn id(&self) -> &str

Get the connection ID.

Source

pub const fn client_info(&self) -> Option<&ClientInfo>

Get the client info.

Source

pub const fn client_capabilities(&self) -> Option<&ClientCapabilities>

Get the client capabilities.

Source

pub fn complete( self, server_info: ServerInfo, server_capabilities: ServerCapabilities, ) -> Connection<Ready>

Complete initialization (transition to Ready state).

This is called after the initialize response is received (client) or sent (server).

Source

pub fn abort(self) -> Connection<Disconnected>

Abort initialization (transition back to Disconnected).

Source§

impl Connection<Ready>

Source

pub fn id(&self) -> &str

Get the connection ID.

Source

pub const fn connected_at(&self) -> Option<Instant>

Get when the connection was established.

Source

pub fn uptime(&self) -> Duration

Get how long the connection has been active.

Source

pub const fn last_activity(&self) -> Option<Instant>

Get the last activity timestamp.

Source

pub fn client_info(&self) -> &ClientInfo

Get the client info.

§Panics

This should never panic if the connection was properly initialized, as the typestate pattern ensures this is only callable in Ready state. Use try_client_info() for a fallible version.

Source

pub const fn try_client_info(&self) -> Option<&ClientInfo>

Try to get the client info.

Returns None if the client info was not set (should not happen in normal use).

Source

pub fn server_info(&self) -> &ServerInfo

Get the server info.

§Panics

This should never panic if the connection was properly initialized, as the typestate pattern ensures this is only callable in Ready state. Use try_server_info() for a fallible version.

Source

pub const fn try_server_info(&self) -> Option<&ServerInfo>

Try to get the server info.

Returns None if the server info was not set (should not happen in normal use).

Source

pub fn client_capabilities(&self) -> &ClientCapabilities

Get the client capabilities.

§Panics

This should never panic if the connection was properly initialized, as the typestate pattern ensures this is only callable in Ready state. Use try_client_capabilities() for a fallible version.

Source

pub const fn try_client_capabilities(&self) -> Option<&ClientCapabilities>

Try to get the client capabilities.

Returns None if the client capabilities were not set (should not happen in normal use).

Source

pub fn server_capabilities(&self) -> &ServerCapabilities

Get the server capabilities.

§Panics

This should never panic if the connection was properly initialized, as the typestate pattern ensures this is only callable in Ready state. Use try_server_capabilities() for a fallible version.

Source

pub const fn try_server_capabilities(&self) -> Option<&ServerCapabilities>

Try to get the server capabilities.

Returns None if the server capabilities were not set (should not happen in normal use).

Source

pub fn next_request_id(&mut self) -> RequestId

Generate the next request ID.

Source

pub fn touch(&mut self)

Update the last activity timestamp.

Source

pub fn is_idle(&self, timeout: Duration) -> bool

Check if the connection has been idle for longer than the given duration.

Source

pub fn shutdown(self) -> Connection<Closing>

Begin shutdown (transition to Closing state).

Source§

impl Connection<Closing>

Source

pub fn id(&self) -> &str

Get the connection ID.

Source

pub fn close(self) -> Connection<Disconnected>

Complete the shutdown (transition to Disconnected state).

Trait Implementations§

Source§

impl<S: Debug> Debug for Connection<S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Connection<Disconnected>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<S> Freeze for Connection<S>

§

impl<S> RefUnwindSafe for Connection<S>
where S: RefUnwindSafe,

§

impl<S> Send for Connection<S>
where S: Send,

§

impl<S> Sync for Connection<S>
where S: Sync,

§

impl<S> Unpin for Connection<S>
where S: Unpin,

§

impl<S> UnwindSafe for Connection<S>
where S: UnwindSafe,

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> 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<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V