svn 0.1.8

Async Rust SVN client for Subversion svn://, svn+ssh://, and ra_svn workflows.
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Async client for Subversion's `svn://` (`ra_svn`) protocol.
//!
//! This crate implements a subset of Subversion's remote access protocol used by
//! `svnserve` (the `svn://` scheme). It is a network client and does **not**
//! implement a working copy.
//!
//! Most users should start with [`RaSvnClient`] to create a connected
//! [`RaSvnSession`].
//!
//! ## Getting started
//!
//! ```rust,no_run
//! use std::time::Duration;
//! use svn::{RaSvnClient, SvnUrl};
//!
//! fn main() -> svn::Result<()> {
//!     let rt = tokio::runtime::Builder::new_current_thread()
//!         .enable_all()
//!         .build()?;
//!
//!     rt.block_on(async {
//!         let url = SvnUrl::parse("svn://example.com/repo")?;
//!         let client = RaSvnClient::new(url, None, None)
//!             .with_read_timeout(Duration::from_secs(30));
//!
//!         // A session reuses one connection and caches server info.
//!         let mut session = client.open_session().await?;
//!         let latest = session.get_latest_rev().await?;
//!         println!("{latest}");
//!         Ok(())
//!     })
//! }
//! ```
//!
//! ## Features
//!
//! - `serde`: enables `Serialize`/`Deserialize` for public data types.
//! - `cyrus-sasl`: enables Cyrus SASL authentication and (when negotiated)
//!   the SASL security layer (requires a system-provided `libsasl2` at runtime).
//! - `ssh`: enables `svn+ssh://` by running `svnserve -t` over SSH (via `russh`).
//!
//! ## Protocol notes
//!
//! - `svn://` is supported.
//! - `svn+ssh://` is supported with the `ssh` feature (see `SshConfig`).
//! - IPv6 URLs must use brackets (for example `svn://[::1]/repo`).
//! - Built-in authentication mechanisms: `ANONYMOUS`, `PLAIN`, and `CRAM-MD5`.
//!   With `cyrus-sasl`, the client can also use Cyrus SASL (including the
//!   optional SASL security layer when negotiated).
//!
//! ## Custom transports
//!
//! If you need to bring your own transport (for example a custom proxy/tunnel),
//! you can connect the stream yourself and then call
//! [`RaSvnClient::open_session_with_stream`].
//!
//! ## Low-level access
//!
//! For raw wire protocol items, see [`raw::SvnItem`].

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(unsafe_code)]

mod client;
mod commit;
mod editor;
mod error;
mod export;
mod highlevel;
mod options;
mod path;
mod pool;
mod rasvn;
#[cfg(feature = "ssh")]
mod ssh;
mod svndiff;
#[cfg(test)]
mod test_support;
mod textdelta;
mod types;
mod url;

pub use client::{RaSvnClient, RaSvnSession};
pub use commit::{CommitBuilder, CommitStreamBuilder, SvndiffMode};
pub use editor::{
    AsyncEditorEventHandler, EditorCommand, EditorEvent, EditorEventHandler, Report, ReportCommand,
};
pub use error::{ServerError, ServerErrorItem, SvnError};
pub use export::{FsEditor, TokioFsEditor};
pub use pool::{
    PooledSession, SessionPool, SessionPoolConfig, SessionPoolHealthCheck, SessionPoolKey,
    SessionPools,
};
#[cfg(feature = "ssh")]
pub use ssh::{SshAuth, SshConfig, SshHostKeyPolicy};
pub use textdelta::{
    RecordedTextDelta, TextDeltaApplier, TextDeltaApplierSync, TextDeltaRecorder, apply_textdelta,
    apply_textdelta_sync,
};
/// Convenience alias for results returned by this crate.
pub type Result<T> = std::result::Result<T, SvnError>;
pub use options::{
    CommitLockToken, CommitOptions, DiffOptions, GetFileOptions, ListOptions, LockManyOptions,
    LockOptions, LockTarget, LogOptions, LogRevProps, ReplayOptions, ReplayRangeOptions,
    StatusOptions, SwitchOptions, UnlockManyOptions, UnlockOptions, UnlockTarget, UpdateOptions,
};
/// Low-level wire-protocol types and helpers.
pub mod raw {
    pub use crate::rasvn::SvnItem;
}
pub use types::{
    BlameLine, Capability, ChangedPath, CommitInfo, Depth, DirEntry, DirListing, DirentField,
    FileRev, FileRevContents, GetFileResult, InheritedProps, LocationEntry, LocationSegment,
    LockDesc, LogEntry, MergeInfoCatalog, MergeInfoInheritance, NodeKind, PropDelta, PropertyList,
    RepositoryInfo, ServerInfo, StatEntry,
};
pub use url::SvnUrl;