Struct RaSvnClient 

pub struct RaSvnClient { /* private fields */ }

A reusable configuration object for connecting to an svn:// server.

Use RaSvnClient::open_session to create a connected RaSvnSession.

Implementations

impl RaSvnClient

pub async fn get_latest_rev(&self) -> Result<u64, SvnError>

Convenience wrapper for RaSvnSession::get_latest_rev.

pub async fn get_file<W: AsyncWrite + Unpin>( &self, path: &str, rev: u64, want_props: bool, out: &mut W, max_bytes: u64, ) -> Result<u64, SvnError>

Convenience wrapper for RaSvnSession::get_file.

pub async fn get_file_bytes( &self, path: &str, rev: u64, max_bytes: u64, ) -> Result<Vec<u8>, SvnError>

Convenience wrapper for RaSvnSession::get_file_bytes.

pub async fn get_file_with_options<W: AsyncWrite + Unpin>( &self, path: &str, options: &GetFileOptions, out: &mut W, ) -> Result<GetFileResult, SvnError>

Convenience wrapper for RaSvnSession::get_file_with_options.

pub async fn get_file_with_result<W: AsyncWrite + Unpin>( &self, path: &str, rev: u64, want_props: bool, out: &mut W, max_bytes: u64, ) -> Result<GetFileResult, SvnError>

Convenience wrapper for RaSvnSession::get_file_with_result.

pub async fn log( &self, start_rev: u64, end_rev: u64, ) -> Result<Vec<LogEntry>, SvnError>

Convenience wrapper for RaSvnSession::log.

pub async fn log_with_options( &self, options: &LogOptions, ) -> Result<Vec<LogEntry>, SvnError>

Convenience wrapper for RaSvnSession::log_with_options.

pub async fn log_each<F>( &self, options: &LogOptions, on_entry: F, ) -> Result<(), SvnError>

where F: FnMut(LogEntry) -> Result<(), SvnError> + Send,

Convenience wrapper for RaSvnSession::log_each.

pub async fn log_each_retrying<F>( &self, options: &LogOptions, on_entry: F, ) -> Result<(), SvnError>

where F: FnMut(LogEntry) -> Result<(), SvnError> + Send,

Convenience wrapper for RaSvnSession::log_each_retrying.

pub async fn get_dated_rev(&self, date: &str) -> Result<u64, SvnError>

Convenience wrapper for RaSvnSession::get_dated_rev.

pub async fn get_mergeinfo( &self, paths: &[String], rev: Option<u64>, inherit: MergeInfoInheritance, include_descendants: bool, ) -> Result<MergeInfoCatalog, SvnError>

Convenience wrapper for RaSvnSession::get_mergeinfo.

pub async fn get_deleted_rev( &self, path: &str, peg_rev: u64, end_rev: u64, ) -> Result<Option<u64>, SvnError>

Convenience wrapper for RaSvnSession::get_deleted_rev.

pub async fn get_locations( &self, path: &str, peg_rev: u64, location_revs: &[u64], ) -> Result<Vec<LocationEntry>, SvnError>

Convenience wrapper for RaSvnSession::get_locations.

pub async fn get_location_segments( &self, path: &str, peg_rev: u64, start_rev: Option<u64>, end_rev: Option<u64>, ) -> Result<Vec<LocationSegment>, SvnError>

Convenience wrapper for RaSvnSession::get_location_segments.

pub async fn get_file_revs( &self, path: &str, start_rev: Option<u64>, end_rev: Option<u64>, include_merged_revisions: bool, ) -> Result<Vec<FileRev>, SvnError>

Convenience wrapper for RaSvnSession::get_file_revs.

pub async fn get_file_revs_each<F>( &self, path: &str, start_rev: Option<u64>, end_rev: Option<u64>, include_merged_revisions: bool, on_rev: F, ) -> Result<(), SvnError>

where F: FnMut(FileRev) -> Result<(), SvnError> + Send,

Convenience wrapper for RaSvnSession::get_file_revs_each.

pub async fn get_file_revs_with_contents( &self, path: &str, start_rev: Option<u64>, end_rev: Option<u64>, include_merged_revisions: bool, max_bytes: u64, ) -> Result<Vec<FileRevContents>, SvnError>

Convenience wrapper for RaSvnSession::get_file_revs_with_contents.

pub async fn rev_proplist(&self, rev: u64) -> Result<PropertyList, SvnError>

Convenience wrapper for RaSvnSession::rev_proplist.

pub async fn rev_prop( &self, rev: u64, name: &str, ) -> Result<Option<Vec<u8>>, SvnError>

Convenience wrapper for RaSvnSession::rev_prop.

pub async fn change_rev_prop( &self, rev: u64, name: &str, value: Option<Vec<u8>>, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::change_rev_prop.

pub async fn change_rev_prop2( &self, rev: u64, name: &str, value: Option<Vec<u8>>, dont_care: bool, previous_value: Option<Vec<u8>>, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::change_rev_prop2.

pub async fn proplist( &self, path: &str, rev: Option<u64>, ) -> Result<Option<PropertyList>, SvnError>

Convenience wrapper for RaSvnSession::proplist.

pub async fn propget( &self, path: &str, rev: Option<u64>, name: &str, ) -> Result<Option<Vec<u8>>, SvnError>

Convenience wrapper for RaSvnSession::propget.

pub async fn inherited_props( &self, path: &str, rev: Option<u64>, ) -> Result<Vec<InheritedProps>, SvnError>

Convenience wrapper for RaSvnSession::inherited_props.

pub async fn get_lock(&self, path: &str) -> Result<Option<LockDesc>, SvnError>

Convenience wrapper for RaSvnSession::get_lock.

pub async fn get_locks( &self, path: &str, depth: Depth, ) -> Result<Vec<LockDesc>, SvnError>

Convenience wrapper for RaSvnSession::get_locks.

pub async fn lock( &self, path: &str, options: &LockOptions, ) -> Result<LockDesc, SvnError>

Convenience wrapper for RaSvnSession::lock.

pub async fn lock_many( &self, options: &LockManyOptions, targets: &[LockTarget], ) -> Result<Vec<Result<LockDesc, SvnError>>, SvnError>

Convenience wrapper for RaSvnSession::lock_many.

pub async fn unlock( &self, path: &str, options: &UnlockOptions, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::unlock.

pub async fn unlock_many( &self, options: &UnlockManyOptions, targets: &[UnlockTarget], ) -> Result<Vec<Result<String, SvnError>>, SvnError>

Convenience wrapper for RaSvnSession::unlock_many.

pub async fn commit( &self, options: &CommitOptions, commands: &[EditorCommand], ) -> Result<CommitInfo, SvnError>

Convenience wrapper for RaSvnSession::commit.

pub async fn list_dir( &self, path: &str, rev: Option<u64>, ) -> Result<DirListing, SvnError>

Convenience wrapper for RaSvnSession::list_dir.

pub async fn list_dir_with_fields( &self, path: &str, rev: Option<u64>, fields: &[DirentField], ) -> Result<DirListing, SvnError>

Convenience wrapper for RaSvnSession::list_dir_with_fields.

pub async fn check_path( &self, path: &str, rev: Option<u64>, ) -> Result<NodeKind, SvnError>

Convenience wrapper for RaSvnSession::check_path.

pub async fn stat( &self, path: &str, rev: Option<u64>, ) -> Result<Option<StatEntry>, SvnError>

Convenience wrapper for RaSvnSession::stat.

pub async fn list( &self, path: &str, rev: Option<u64>, depth: Depth, fields: &[DirentField], patterns: Option<&[String]>, ) -> Result<Vec<DirEntry>, SvnError>

Convenience wrapper for RaSvnSession::list.

pub async fn list_with_options( &self, options: &ListOptions, ) -> Result<Vec<DirEntry>, SvnError>

Convenience wrapper for RaSvnSession::list_with_options.

pub async fn list_with_options_each<F>( &self, options: &ListOptions, on_entry: F, ) -> Result<(), SvnError>

where F: FnMut(DirEntry) -> Result<(), SvnError> + Send,

Convenience wrapper for RaSvnSession::list_with_options_each.

pub async fn list_recursive( &self, path: &str, rev: Option<u64>, ) -> Result<Vec<DirEntry>, SvnError>

Convenience wrapper for RaSvnSession::list_recursive.

pub async fn update( &self, options: &UpdateOptions, report: &Report, handler: &mut dyn EditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::update.

pub async fn update_with_async_handler( &self, options: &UpdateOptions, report: &Report, handler: &mut dyn AsyncEditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::update_with_async_handler.

pub async fn switch( &self, options: &SwitchOptions, report: &Report, handler: &mut dyn EditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::switch.

pub async fn switch_with_async_handler( &self, options: &SwitchOptions, report: &Report, handler: &mut dyn AsyncEditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::switch_with_async_handler.

pub async fn status( &self, options: &StatusOptions, report: &Report, handler: &mut dyn EditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::status.

pub async fn status_with_async_handler( &self, options: &StatusOptions, report: &Report, handler: &mut dyn AsyncEditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::status_with_async_handler.

pub async fn diff( &self, options: &DiffOptions, report: &Report, handler: &mut dyn EditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::diff.

pub async fn diff_with_async_handler( &self, options: &DiffOptions, report: &Report, handler: &mut dyn AsyncEditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::diff_with_async_handler.

pub async fn replay( &self, options: &ReplayOptions, handler: &mut dyn EditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::replay.

pub async fn replay_with_async_handler( &self, options: &ReplayOptions, handler: &mut dyn AsyncEditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::replay_with_async_handler.

pub async fn replay_range( &self, options: &ReplayRangeOptions, handler: &mut dyn EditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::replay_range.

pub async fn replay_range_with_async_handler( &self, options: &ReplayRangeOptions, handler: &mut dyn AsyncEditorEventHandler, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::replay_range_with_async_handler.

impl RaSvnClient

pub fn new( base_url: SvnUrl, username: Option<String>, password: Option<String>, ) -> Self

Creates a client configuration for a repository URL and optional credentials.

Credentials are used when the server offers an auth mechanism supported by this crate (for example PLAIN or CRAM-MD5).

pub fn base_url(&self) -> &SvnUrl

Returns the configured base URL.

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

Returns the configured username, if any.

pub fn connect_timeout(&self) -> Duration

Returns the configured connect timeout.

pub fn read_timeout(&self) -> Duration

Returns the configured read timeout.

pub fn write_timeout(&self) -> Duration

Returns the configured write timeout.

pub fn ra_client(&self) -> &str

Returns the configured ra_client string sent during handshake.

pub fn with_connect_timeout(self, connect_timeout: Duration) -> Self

Sets the connect timeout.

pub fn with_read_timeout(self, read_timeout: Duration) -> Self

Sets the read timeout.

pub fn with_write_timeout(self, write_timeout: Duration) -> Self

Sets the write timeout.

pub fn with_ra_client(self, ra_client: impl Into<String>) -> Self

Sets the ra_client string sent to the server during handshake.

pub fn with_reconnect_retries(self, retries: usize) -> Self

Sets how many times to reconnect and retry an operation on transient connection failures (for example unexpected EOF).

This affects:

• the initial handshake performed by RaSvnClient::open_session;
• per-operation reconnects performed by RaSvnSession methods that use automatic retry.

0 disables retries (one attempt only). The default is 1.

pub fn reconnect_retries(&self) -> usize

Returns the configured reconnect retry count.

pub fn with_ssh_config(self, ssh: SshConfig) -> Self

Available on crate feature ssh only.

Sets the SSH transport configuration for svn+ssh:// URLs.

This is ignored for svn:// URLs.

pub async fn open_session(&self) -> Result<RaSvnSession, SvnError>

Opens a new TCP connection, performs the ra_svn handshake, and returns a RaSvnSession.

pub async fn open_session_with_stream<S>( &self, stream: S, ) -> Result<RaSvnSession, SvnError>

where S: AsyncRead + AsyncWrite + Send + 'static,

Opens a session over an already connected stream.

This is useful if you want to provide your own transport (for example a tunnel or custom proxy). The stream must already be connected to the same host:port as RaSvnClient::base_url.

Sessions created by this method do not auto-reconnect on I/O errors (because the crate cannot recreate your custom transport). If the stream is dropped, create a new session yourself.

impl RaSvnClient

pub async fn export_to_dir( &self, options: &UpdateOptions, dest: impl AsRef<Path>, ) -> Result<(), SvnError>

Convenience wrapper for RaSvnSession::export_to_dir.

impl RaSvnClient

pub async fn diff_file_unified( &self, path: &str, old_rev: u64, new_rev: u64, max_bytes: u64, ) -> Result<String, SvnError>

Convenience wrapper for RaSvnSession::diff_file_unified.

pub async fn blame_file( &self, path: &str, start_rev: Option<u64>, end_rev: Option<u64>, include_merged_revisions: bool, max_bytes: u64, ) -> Result<Vec<BlameLine>, SvnError>

Convenience wrapper for RaSvnSession::blame_file.

impl RaSvnClient

pub fn session_pool(&self, max_sessions: usize) -> Result<SessionPool, SvnError>

Creates a SessionPool using this client configuration.

pub fn session_pool_with_config( &self, config: SessionPoolConfig, ) -> Result<SessionPool, SvnError>

Creates a SessionPool using this client configuration and config.

Trait Implementations

impl Clone for RaSvnClient

fn clone(&self) -> RaSvnClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RaSvnClient

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

Formats the value using the given formatter.