Struct appconfig::AppConfigManager [−][src]
A manager that manages a single configuration file.
By default, the configuration file will be saved automatically when the manager is dropped. The name of the folder where the configuration file will be saved will be the FQDN consisting of the specified organization name and application name.
e.g.
com.{organization_name}.{app_name}/app_config.toml
Implementations
impl<T> AppConfigManager<T> where
T: Sized + Serialize + DeserializeOwned,
[src]
T: Sized + Serialize + DeserializeOwned,
pub fn new(
data: Rc<RefCell<T>>,
app_name: impl Into<String>,
organization_name: impl Into<String>
) -> Self
[src]
data: Rc<RefCell<T>>,
app_name: impl Into<String>,
organization_name: impl Into<String>
) -> Self
pub fn set_skip_parsing_error_when_loading(&mut self, value: bool) -> &mut Self
[src]
pub fn with_skip_parsing_error_when_loading(self, value: bool) -> Self
[src]
pub fn set_auto_saving(&mut self, value: bool) -> &mut Self
[src]
pub fn with_auto_saving(self, value: bool) -> Self
[src]
pub fn set_organization_name(&mut self, value: impl Into<String>) -> &mut Self
[src]
pub fn with_organization_name(self, value: impl Into<String>) -> Self
[src]
pub fn set_app_name(&mut self, value: impl Into<String>) -> &mut Self
[src]
pub fn with_app_name(self, value: impl Into<String>) -> Self
[src]
pub fn load(&self) -> Result<(), Box<dyn Error>>
[src]
pub fn save(&self) -> Result<(), Box<dyn Error>>
[src]
pub fn data(&self) -> &RefCell<T>
[src]
Methods from Deref<Target = RefCell<T>>
pub fn replace(&self, t: T) -> T
1.24.0[src]
Replaces the wrapped value with a new one, returning the old value, without deinitializing either one.
This function corresponds to std::mem::replace
.
Panics
Panics if the value is currently borrowed.
Examples
use std::cell::RefCell; let cell = RefCell::new(5); let old_value = cell.replace(6); assert_eq!(old_value, 5); assert_eq!(cell, RefCell::new(6));
pub fn replace_with<F>(&self, f: F) -> T where
F: FnOnce(&mut T) -> T,
1.35.0[src]
F: FnOnce(&mut T) -> T,
Replaces the wrapped value with a new one computed from f
, returning
the old value, without deinitializing either one.
Panics
Panics if the value is currently borrowed.
Examples
use std::cell::RefCell; let cell = RefCell::new(5); let old_value = cell.replace_with(|&mut old| old + 1); assert_eq!(old_value, 5); assert_eq!(cell, RefCell::new(6));
pub fn swap(&self, other: &RefCell<T>)
1.24.0[src]
Swaps the wrapped value of self
with the wrapped value of other
,
without deinitializing either one.
This function corresponds to std::mem::swap
.
Panics
Panics if the value in either RefCell
is currently borrowed.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let d = RefCell::new(6); c.swap(&d); assert_eq!(c, RefCell::new(6)); assert_eq!(d, RefCell::new(5));
pub fn borrow(&self) -> Ref<'_, T>
1.0.0[src]
Immutably borrows the wrapped value.
The borrow lasts until the returned Ref
exits scope. Multiple
immutable borrows can be taken out at the same time.
Panics
Panics if the value is currently mutably borrowed. For a non-panicking variant, use
try_borrow
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let borrowed_five = c.borrow(); let borrowed_five2 = c.borrow();
An example of panic:
use std::cell::RefCell; let c = RefCell::new(5); let m = c.borrow_mut(); let b = c.borrow(); // this causes a panic
pub fn try_borrow(&self) -> Result<Ref<'_, T>, BorrowError>
1.13.0[src]
Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.
The borrow lasts until the returned Ref
exits scope. Multiple immutable borrows can be
taken out at the same time.
This is the non-panicking variant of borrow
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow_mut(); assert!(c.try_borrow().is_err()); } { let m = c.borrow(); assert!(c.try_borrow().is_ok()); }
pub fn borrow_mut(&self) -> RefMut<'_, T>
1.0.0[src]
Mutably borrows the wrapped value.
The borrow lasts until the returned RefMut
or all RefMut
s derived
from it exit scope. The value cannot be borrowed while this borrow is
active.
Panics
Panics if the value is currently borrowed. For a non-panicking variant, use
try_borrow_mut
.
Examples
use std::cell::RefCell; let c = RefCell::new("hello".to_owned()); *c.borrow_mut() = "bonjour".to_owned(); assert_eq!(&*c.borrow(), "bonjour");
An example of panic:
use std::cell::RefCell; let c = RefCell::new(5); let m = c.borrow(); let b = c.borrow_mut(); // this causes a panic
pub fn try_borrow_mut(&self) -> Result<RefMut<'_, T>, BorrowMutError>
1.13.0[src]
Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
The borrow lasts until the returned RefMut
or all RefMut
s derived
from it exit scope. The value cannot be borrowed while this borrow is
active.
This is the non-panicking variant of borrow_mut
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow(); assert!(c.try_borrow_mut().is_err()); } assert!(c.try_borrow_mut().is_ok());
pub fn as_ptr(&self) -> *mut T
1.12.0[src]
Returns a raw pointer to the underlying data in this cell.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let ptr = c.as_ptr();
pub unsafe fn try_borrow_unguarded(&self) -> Result<&T, BorrowError>
1.37.0[src]
Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.
Safety
Unlike RefCell::borrow
, this method is unsafe because it does not
return a Ref
, thus leaving the borrow flag untouched. Mutably
borrowing the RefCell
while the reference returned by this method
is alive is undefined behaviour.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow_mut(); assert!(unsafe { c.try_borrow_unguarded() }.is_err()); } { let m = c.borrow(); assert!(unsafe { c.try_borrow_unguarded() }.is_ok()); }
Trait Implementations
impl<T> Deref for AppConfigManager<T> where
T: Sized + Serialize + DeserializeOwned,
[src]
T: Sized + Serialize + DeserializeOwned,
type Target = RefCell<T>
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
impl<T> Drop for AppConfigManager<T> where
T: Sized + Serialize + DeserializeOwned,
[src]
T: Sized + Serialize + DeserializeOwned,
Auto Trait Implementations
impl<T> !RefUnwindSafe for AppConfigManager<T>
impl<T> !Send for AppConfigManager<T>
impl<T> !Sync for AppConfigManager<T>
impl<T> Unpin for AppConfigManager<T>
impl<T> !UnwindSafe for AppConfigManager<T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,