Struct Filestore 

pub struct Filestore { /* private fields */ }

File-based storage manager for proxies, sources, and configuration

The Filestore provides methods for loading and saving data to the filesystem, managing proxy lists, source lists, and configuration files.

It handles file operations, serialization/deserialization, and ensures data consistency when reading and writing files.

Examples

use gooty_proxy::io::filestore::{Filestore, FilestoreConfig};

// Create a filestore with default configuration
let filestore = Filestore::new().unwrap();

// Create a filestore with custom configuration
let config = FilestoreConfig {
    data_dir: "custom_data".to_string(),
    ..Default::default()
};
let filestore = Filestore::with_config(config).unwrap();

// Load proxies from a file
let proxies = filestore.load_proxies("my_proxies").unwrap();

Implementations

impl Filestore

pub fn new() -> FilestoreResult<Self>

Create a new filestore with default configuration

Creates a new filestore that stores data in the “data” directory.

Returns

A new Filestore instance

Errors

Returns an error if the data directory cannot be created or accessed

pub fn with_config(config: FilestoreConfig) -> FilestoreResult<Self>

Create a new filestore with custom configuration

Arguments

• config - Configuration settings for the filestore

Returns

A new Filestore instance with the specified configuration

Errors

Returns an error if the data directory cannot be created or accessed

pub fn load_proxies(&self, name: &str) -> FilestoreResult<Vec<Proxy>>

Load proxies from a file

Arguments

• name - Base name of the file (without extension)

Returns

A vector of Proxy objects loaded from the file

Errors

Returns an error if:

• The file doesn’t exist and create_defaults_if_missing is false
• The file exists but cannot be read
• The file content is not valid TOML
• The TOML cannot be deserialized into proxies

pub fn save_proxies(&self, proxies: &[Proxy], name: &str) -> FilestoreResult<()>

Save proxies to a file

Arguments

• proxies - Vector of proxies to save
• name - Base name of the file (without extension)

Returns

Ok(()) if the proxies were successfully saved

Errors

Returns an error if:

• The file cannot be created or written to
• The proxies cannot be serialized to TOML

pub fn load_sources(&self, name: &str) -> FilestoreResult<Vec<Source>>

Load sources from a file

Arguments

• name - Base name of the file (without extension)

Returns

A vector of Source objects loaded from the file

Errors

Returns an error if:

• The file doesn’t exist and create_defaults_if_missing is false
• The file exists but cannot be read
• The file content is not valid TOML
• The TOML cannot be deserialized into sources

pub fn save_sources( &self, sources: &[Source], name: &str, ) -> FilestoreResult<()>

Save sources to a file

Arguments

• sources - Vector of sources to save
• name - Base name of the file (without extension)

Returns

Ok(()) if the sources were successfully saved

Errors

Returns an error if:

• The file cannot be created or written to
• The sources cannot be serialized to TOML

pub fn load_config(&self, name: &str) -> FilestoreResult<AppConfig>

Load application configuration from a file

Arguments

• name - Base name of the file (without extension)

Returns

An AppConfig object loaded from the file

Errors

Returns an error if:

• The file doesn’t exist and create_defaults_if_missing is false
• The file exists but cannot be read
• The file content is not valid TOML
• The TOML cannot be deserialized into AppConfig

pub fn save_config(&self, config: &AppConfig, name: &str) -> FilestoreResult<()>

Save application configuration to a file

Arguments

• config - AppConfig object to save
• name - Base name of the file (without extension)

Returns

Ok(()) if the configuration was successfully saved

Errors

Returns an error if:

• The file cannot be created or written to
• The configuration cannot be serialized to TOML

pub fn get_base_dir(&self) -> &PathBuf

Get the base directory where files are stored

Returns

Reference to the base directory path

pub fn get_config(&self) -> &FilestoreConfig

Get the current filestore configuration

Returns

Reference to the current configuration