Struct RecoveryService 

pub struct RecoveryService { /* private fields */ }

The main recovery service

This is the high-level interface for the recovery system. It manages the session lock and coordinates buffer recovery.

Implementations

impl RecoveryService

pub fn new() -> Result<Self>

Create a new recovery service

pub fn with_config(config: RecoveryConfig) -> Result<Self>

Create a new recovery service with custom config

pub fn with_storage_dir(storage_dir: PathBuf) -> Self

Create a new recovery service with a custom storage directory This is useful for testing with isolated temporary directories

pub fn with_config_and_dir(config: RecoveryConfig, storage_dir: PathBuf) -> Self

Create a new recovery service with custom config and storage directory

pub fn with_scope( config: RecoveryConfig, base_recovery_dir: &Path, scope: &RecoveryScope, ) -> Self

Create a new recovery service scoped to a session or working directory.

Performs one-time migration of old flat-layout recovery files if needed.

pub fn is_enabled(&self) -> bool

Check if recovery is enabled

pub fn storage(&self) -> &RecoveryStorage

Get the storage backend

pub fn should_offer_recovery(&self) -> Result<bool>

Check if we should offer recovery (crash detected)

pub fn start_session(&mut self) -> Result<()>

Start a new session (call on editor startup after recovery handling)

pub fn end_session_preserving(&mut self, preserve_ids: &[String]) -> Result<()>

End the session cleanly (call on normal editor shutdown)

When preserve_ids is provided, recovery files matching those IDs are kept (used to persist unnamed buffer contents across sessions).

pub fn end_session(&mut self) -> Result<()>

End the session cleanly (call on normal editor shutdown)

pub fn heartbeat(&self) -> Result<()>

Update session heartbeat (call periodically)

pub fn needs_auto_recovery_save( &self, _buffer_id: &str, recovery_pending: bool, ) -> bool

Check if a buffer needs auto-recovery-save

Returns true if recovery_pending is true. The recovery_pending flag is now tracked on the buffer itself (TextBuffer.recovery_pending) rather than in this service.

pub fn get_buffer_id(&self, path: Option<&Path>) -> String

Get buffer ID for a path

pub fn save_buffer( &mut self, buffer_id: &str, chunks: Vec<RecoveryChunk>, original_path: Option<&Path>, buffer_name: Option<&str>, line_count: Option<usize>, original_file_size: usize, final_size: usize, ) -> Result<()>

Save a buffer’s content for recovery

All recovery uses the chunked format:

• For small files/new buffers: pass a single chunk containing full content with offset=0, original_len=0, original_file_size=0
• For large files: pass only the modified chunks with their offsets

Parameters

• buffer_id: Unique identifier for the buffer
• chunks: The content chunks to save
• original_path: Path to the original file (None for new buffers)
• buffer_name: Display name for the buffer
• line_count: Number of lines in the buffer
• original_file_size: Size of the original file (0 for new buffers)
• final_size: Total size after applying all modifications

pub fn delete_buffer_recovery(&mut self, buffer_id: &str) -> Result<()>

Delete recovery for a buffer (call when buffer is saved normally or closed)

pub fn list_recoverable(&self) -> Result<Vec<RecoveryEntry>>

List all recoverable entries

pub fn load_recovery(&self, entry: &RecoveryEntry) -> Result<RecoveryResult>

Load recovery content for a specific entry

For entries with original_file_size > 0, returns RecoveredChunks so the caller can apply chunks directly to the buffer (more efficient than full reconstruction). For new buffer entries (original_file_size == 0), the full content is in the chunks.

pub fn load_recovery_with_original( &self, entry: &RecoveryEntry, original_file: &Path, ) -> Result<RecoveryResult>

Load recovery with a provided original file path

Use this when the original file has moved or you want to specify a different source.

pub fn accept_recovery( &mut self, entry: &RecoveryEntry, ) -> Result<RecoveryResult>

Accept recovery for an entry (load and delete recovery file)

pub fn discard_recovery(&mut self, entry: &RecoveryEntry) -> Result<()>

Discard recovery for an entry

pub fn discard_all_recovery(&mut self) -> Result<usize>

Discard all recovery files

pub fn cleanup_old(&self) -> Result<usize>

Clean up old recovery files (older than max_recovery_age_secs)

pub fn cleanup_orphans(&self) -> Result<usize>

Clean up orphaned files

Trait Implementations

impl Debug for RecoveryService

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

Formats the value using the given formatter.

impl Default for RecoveryService

fn default() -> Self

Returns the “default value” for a type.