rustnetconf 0.12.0

An async-first NETCONF 1.0/1.1 client library for Rust
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

//! # rustnetconf
//!
//! An async-first NETCONF 1.0/1.1 client library for Rust.
//!
//! Built on [tokio](https://tokio.rs) and [russh](https://crates.io/crates/russh)
//! for high-performance, memory-safe network device management.
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use rustnetconf::{Client, Datastore};
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let mut client = Client::connect("10.0.0.1:830")
//!         .username("admin")
//!         .password("secret")
//!         .connect()
//!         .await?;
//!
//!     let config = client.get_config(Datastore::Running).await?;
//!     println!("{config}");
//!
//!     client.close_session().await?;
//!     Ok(())
//! }
//! ```
//!
//! ## Architecture
//!
//! ```text
//! Client (thin wrapper) → Session (protocol state) → Framing → Transport (SSH)
//! ```
//!
//! See [ARCHITECTURE.md](https://github.com/fastrevmd-lab/rustnetconf/blob/main/ARCHITECTURE.md)
//! for full design details.

pub mod capability;
pub mod client;
pub mod error;
pub mod facts;
pub mod framing;
pub mod notification;
pub mod pool;
pub mod rpc;
pub mod session;
pub mod ssh_config;
pub mod transport;
pub mod types;
pub mod vendor;

// Re-export the primary public API types
pub use client::{Client, ClientBuilder, EditConfigBuilder};
pub use error::NetconfError;
pub use facts::Facts;
pub use notification::Notification;
pub use rpc::RpcErrorInfo;
pub use ssh_config::{ResolvedHost, SshConfigError, SshConfigFile};
pub use types::{
    Datastore, DefaultOperation, ErrorOption, LoadAction, LoadFormat, OpenConfigurationMode,
    TestOption,
};

#[cfg(feature = "tls")]
pub use client::TlsClientBuilder;
#[cfg(feature = "tls")]
pub use transport::tls::TlsConfig;