rneter 0.4.4

SSH connection manager for network devices with intelligent state machine handling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Error types for SSH connection and device state management.
//!
//! This module defines all errors that can occur during SSH operations,
//! device state transitions, and command execution.

use thiserror::Error;
use tokio::sync::mpsc::error::SendError;

/// Errors that can occur during SSH connection and device state management.
#[derive(Error, Debug)]
pub enum ConnectError {
    /// The target state cannot be reached from the current state.
    #[error("unreachable state {0}")]
    UnreachableState(String),

    /// The target state does not exist in the configuration.
    #[error("target state does not exist")]
    TargetStateNotExistError,

    /// The SSH channel was disconnected while waiting for a prompt.
    #[error("channel disconnected while waiting for prompt")]
    ChannelDisconnectError,

    /// The SSH connection has been closed.
    #[error("connection closed")]
    ConnectClosedError,

    /// No exit command is defined for the specified state.
    #[error("{0} no exit command")]
    NoExitCommandError(String),

    /// Command execution timed out.
    #[error("exec command timeout: {0}")]
    ExecTimeout(String),

    /// SSH connection initialization timed out while waiting for initial prompt.
    #[error("connection initialization timeout: {0}")]
    InitTimeout(String),

    /// Device handler configuration is invalid.
    #[error("invalid device handler config: {0}")]
    InvalidDeviceHandlerConfig(String),

    /// Interactive command prompt-response rules are invalid.
    #[error("invalid command interaction: {0}")]
    InvalidCommandInteraction(String),

    /// Command flow definition is invalid at runtime.
    #[error("invalid command flow: {0}")]
    InvalidCommandFlow(String),

    /// Command flow template definition or rendering is invalid.
    #[error("invalid command flow template: {0}")]
    InvalidCommandFlowTemplate(String),

    /// An error occurred in the async-ssh2-tokio library.
    #[error("async ssh2 error: {0}")]
    Ssh2Error(#[from] async_ssh2_tokio::Error),

    /// An error occurred in the russh library.
    #[error("russh error: {0}")]
    RusshError(#[from] russh::Error),

    /// Failed to send data through the channel.
    #[error("Failed to send data: {0}")]
    SendDataError(#[from] SendError<String>),

    /// Requested template is not found.
    #[error("template not found: {0}")]
    TemplateNotFound(String),

    /// Replay data does not match expected command/mode flow.
    #[error("replay mismatch: {0}")]
    ReplayMismatchError(String),

    /// Transaction block is invalid.
    #[error("invalid transaction block: {0}")]
    InvalidTransaction(String),

    /// An internal server error occurred.
    #[error("Internal server error: {0}")]
    InternalServerError(String),
}