Struct scsys_core::ConfigFile

source · [−]

pub struct ConfigFile<T, F> { /* private fields */ }

Expand description

A configuration source backed up by a file.

It supports optional automatic file format discovery.

Implementations

source

pub fn with_name(name: &str) -> File<FileSourceFile, FileFormat>

Given the basename of a file, will attempt to locate a file by setting its extension to a registered format.

source

impl<T, F> File<T, F> where
F: 'static + FileStoredFormat,
T: FileSource<F>,

source

pub fn format(self, format: F) -> File<T, F>

source

pub fn required(self, required: bool) -> File<T, F>

Trait Implementations

source

impl<T, F> Clone for File<T, F> where
T: Clone,
F: Clone,

source

fn clone(&self) -> File<T, F>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<T, F> Debug for File<T, F> where
T: Debug,
F: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<'a> From<&'a Path> for File<FileSourceFile, FileFormat>

source

fn from(path: &'a Path) -> File<FileSourceFile, FileFormat>

Converts to this type from the input type.

source

impl From<PathBuf> for File<FileSourceFile, FileFormat>

source

fn from(path: PathBuf) -> File<FileSourceFile, FileFormat>

Converts to this type from the input type.

source

impl<T, F> Source for File<T, F> where
F: 'static + FileStoredFormat + Debug + Clone + Send + Sync,
T: 'static + Sync + Send + FileSource<F>,

source

fn clone_into_box(&self) -> Box<dyn Source + Send + Sync + 'static, Global>

source

fn collect(&self) -> Result<HashMap<String, Value, RandomState>, ConfigError>

Collect all configuration properties available from this source and return a Map. Read more

source

fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>

Collects all configuration properties to a provided cache.

Auto Trait Implementations

impl<T, F> RefUnwindSafe for File<T, F> where
F: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, F> Send for File<T, F> where
F: Send,
T: Send,

impl<T, F> Sync for File<T, F> where
F: Sync,
T: Sync,

impl<T, F> Unpin for File<T, F> where
F: Unpin,
T: Unpin,

impl<T, F> UnwindSafe for File<T, F> where
F: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct scsys_core::ConfigFile

Implementations

impl<F> File<FileSourceString, F> where F: 'static + FileStoredFormat,

pub fn from_str(s: &str, format: F) -> File<FileSourceString, F>

impl<F> File<FileSourceFile, F> where F: 'static + FileStoredFormat,

pub fn new(name: &str, format: F) -> File<FileSourceFile, F>

impl File<FileSourceFile, FileFormat>

pub fn with_name(name: &str) -> File<FileSourceFile, FileFormat>

impl<T, F> File<T, F> where F: 'static + FileStoredFormat, T: FileSource<F>,

pub fn format(self, format: F) -> File<T, F>

pub fn required(self, required: bool) -> File<T, F>

Trait Implementations

impl<T, F> Clone for File<T, F> where T: Clone, F: Clone,

fn clone(&self) -> File<T, F>

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

impl<T, F> Debug for File<T, F> where T: Debug, F: Debug,

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

impl<'a> From<&'a Path> for File<FileSourceFile, FileFormat>

fn from(path: &'a Path) -> File<FileSourceFile, FileFormat>

impl From<PathBuf> for File<FileSourceFile, FileFormat>

fn from(path: PathBuf) -> File<FileSourceFile, FileFormat>

impl<T, F> Source for File<T, F> where F: 'static + FileStoredFormat + Debug + Clone + Send + Sync, T: 'static + Sync + Send + FileSource<F>,

fn clone_into_box(&self) -> Box<dyn Source + Send + Sync + 'static, Global>

fn collect(&self) -> Result<HashMap<String, Value, RandomState>, ConfigError>

fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>

Auto Trait Implementations

impl<T, F> RefUnwindSafe for File<T, F> where F: RefUnwindSafe, T: RefUnwindSafe,

impl<T, F> Send for File<T, F> where F: Send, T: Send,

impl<T, F> Sync for File<T, F> where F: Sync, T: Sync,

impl<T, F> Unpin for File<T, F> where F: Unpin, T: Unpin,

impl<T, F> UnwindSafe for File<T, F> where F: UnwindSafe, T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<F> File<FileSourceString, F> where
F: 'static + FileStoredFormat,

impl<F> File<FileSourceFile, F> where
F: 'static + FileStoredFormat,

impl<T, F> File<T, F> where
F: 'static + FileStoredFormat,
T: FileSource<F>,

impl<T, F> Clone for File<T, F> where
T: Clone,
F: Clone,

impl<T, F> Debug for File<T, F> where
T: Debug,
F: Debug,

impl<T, F> Source for File<T, F> where
F: 'static + FileStoredFormat + Debug + Clone + Send + Sync,
T: 'static + Sync + Send + FileSource<F>,

impl<T, F> RefUnwindSafe for File<T, F> where
F: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, F> Send for File<T, F> where
F: Send,
T: Send,

impl<T, F> Sync for File<T, F> where
F: Sync,
T: Sync,

impl<T, F> Unpin for File<T, F> where
F: Unpin,
T: Unpin,

impl<T, F> UnwindSafe for File<T, F> where
F: UnwindSafe,
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,