Struct Fs 

pub struct Fs<F> {
    pub dir: Arc<Path>,
    pub format: F,
    pub buffer: Arc<Mutex<Vec<u8>>>,
    pub prev_retrieve_time: Arc<RwLock<SystemTime>>,
    pub cached: Arc<RwLock<Config>>,
}

Filesystem Configuration Backend

Structure

|- config.json
|- plugin/
|  |- plugin_code.json
|- gateway/
|  |- admin/
|  |  |- config.json
|  |  |- route/
|  |  |  |- static.json
|  |  |  |- api.json
|  |- app.json

Fields

dir: Arc<Path>

format: F

buffer: Arc<Mutex<Vec<u8>>>

prev_retrieve_time: Arc<RwLock<SystemTime>>

cached: Arc<RwLock<Config>>

Implementations

impl<F> Fs<F>

where F: ConfigFormat,

pub fn entrance_config_path(&self) -> PathBuf

pub async fn collect_config( &self, ) -> Result<Config, Box<dyn Error + Send + Sync>>

pub async fn save_config( &self, config: Config, ) -> Result<(), Box<dyn Error + Send + Sync>>

pub async fn collect_gateway_item_config( &self, gateway_name: &str, ) -> Result<Option<ConfigItem>, Box<dyn Error + Send + Sync>>

pub async fn retrieve_cached<M, T>( &self, map: M, ) -> Result<T, Box<dyn Error + Send + Sync>>

where M: FnOnce(&Config) -> T,

pub async fn modify_cached<M>( &self, map: M, ) -> Result<(), Box<dyn Error + Send + Sync>>

where M: FnOnce(&mut Config) -> Result<(), Box<dyn Error + Send + Sync>>,

pub fn new<P>(dir: P, format: F) -> Fs<F>

where P: AsRef<Path>,

pub async fn clear_cache(&self)

pub fn gateway_suffix(&self) -> OsString

pub fn gateway_dir(&self) -> PathBuf

pub fn gateway_main_config_path(&self, gateway_name: &str) -> PathBuf

pub fn routes_dir(&self, gateway_name: &str) -> PathBuf

pub fn route_path(&self, gateway_name: &str, route_name: &str) -> PathBuf

pub fn plugin_dir(&self) -> PathBuf

pub fn plugin_path(&self, id: &PluginInstanceId) -> PathBuf

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

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

Trait Implementations

impl<F> Clone for Fs<F>

where F: Clone,

fn clone(&self) -> Fs<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Create for Fs<F>

where F: ConfigFormat + Send + Sync,

async fn create_plugin( &self, id: &PluginInstanceId, value: Value, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn create_config_item( &self, gateway_name: &str, item: ConfigItem, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn create_config_item_gateway( &self, gateway_name: &str, gateway: SgGateway, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn create_config_item_route( &self, gateway_name: &str, route_name: &str, route: SgHttpRoute, ) -> Result<(), Box<dyn Error + Send + Sync>>

fn create_config( &self, config: Config, ) -> impl Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send

impl<F> CreateListener for Fs<F>

where F: ConfigFormat + Clone + Send + Sync + 'static,

const CONFIG_LISTENER_NAME: &'static str = "file"

type Listener = FsListener

async fn create_listener( &self, ) -> Result<(Config, <Fs<F> as CreateListener>::Listener), Box<dyn Error + Send + Sync>>

impl<F> Debug for Fs<F>

where F: Debug,

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

Formats the value using the given formatter.

impl<F> Delete for Fs<F>

where F: ConfigFormat + Send + Sync,

async fn delete_plugin( &self, id: &PluginInstanceId, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn delete_config_item_gateway( &self, gateway_name: &str, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn delete_config_item_route( &self, gateway_name: &str, route_name: &str, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn delete_config_item( &self, gateway_name: &str, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn delete_config_item_all_routes( &self, gateway_name: &str, ) -> Result<(), Box<dyn Error + Send + Sync>>

impl<F> Discovery for Fs<F>

where F: ConfigFormat + Send + Sync + 'static,

async fn instances( &self, ) -> Result<Vec<impl Instance>, Box<dyn Error + Send + Sync>>

async fn backends( &self, ) -> Result<Vec<BackendHost>, Box<dyn Error + Send + Sync>>

impl<F> Retrieve for Fs<F>

where F: ConfigFormat + Send + Sync,

async fn retrieve_all_plugins( &self, ) -> Result<Vec<PluginConfig>, Box<dyn Error + Send + Sync>>

async fn retrieve_plugin( &self, id: &PluginInstanceId, ) -> Result<Option<PluginConfig>, Box<dyn Error + Send + Sync>>

async fn retrieve_config_item_gateway( &self, gateway_name: &str, ) -> Result<Option<SgGateway>, Box<dyn Error + Send + Sync>>

async fn retrieve_config_item_route( &self, gateway_name: &str, route_name: &str, ) -> Result<Option<SgHttpRoute>, Box<dyn Error + Send + Sync>>

async fn retrieve_config_item_route_names( &self, name: &str, ) -> Result<Vec<String>, Box<dyn Error + Send + Sync>>

async fn retrieve_config_names( &self, ) -> Result<Vec<String>, Box<dyn Error + Send + Sync>>

async fn retrieve_config(&self) -> Result<Config, Box<dyn Error + Send + Sync>>

async fn retrieve_plugins_by_code( &self, code: &str, ) -> Result<Vec<PluginConfig>, Box<dyn Error + Send + Sync>>

fn retrieve_config_item_all_routes( &self, name: &str, ) -> impl Future<Output = Result<BTreeMap<String, SgHttpRoute>, Box<dyn Error + Send + Sync>>> + Send

fn retrieve_config_item( &self, name: &str, ) -> impl Future<Output = Result<Option<ConfigItem>, Box<dyn Error + Send + Sync>>> + Send

impl<F> Update for Fs<F>

where F: ConfigFormat + Send + Sync,

async fn update_plugin( &self, id: &PluginInstanceId, value: Value, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn update_config_item_gateway( &self, gateway_name: &str, gateway: SgGateway, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn update_config_item_route( &self, gateway_name: &str, route_name: &str, route: SgHttpRoute, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn update_config_item( &self, gateway_name: &str, item: ConfigItem, ) -> Result<(), Box<dyn Error + Send + Sync>>

async fn update_config( &self, config: Config, ) -> Result<(), Box<dyn Error + Send + Sync>>