Struct config::FileSource

pub struct FileSource {
    pub path: PathBuf,
    pub optional: bool,
    pub reload_on_change: bool,
    pub reload_delay: Duration,
}

Represents a file configuration source.

Fields

path: PathBuf

Gets or sets the source file path.

optional: bool

Gets or sets a value indicating whether the file is optional. The default value is false.

reload_on_change: bool

Gets or sets a value indicating whether the file will be loaded if the underlying file changes. The default value is false.

reload_delay: Duration

Get or sets the amount of time to wait after a change before reloading. The default value is 250ms.

Remarks

This helps avoid triggering reload before a file is completely written.

Implementations

impl FileSource

pub fn new( path: PathBuf, optional: bool, reload_on_change: bool, reload_delay: Option<Duration> ) -> Self

Initializes a new file configuration source.

Arguments

• path - The source file path
• optional - Indicates whether the source file must exist
• reload_on_change - Indicates if a reload should occur if the source file changes
• reload_delay - The amount of delay before reload after the source file changes

pub fn optional<P: AsRef<Path>>(path: P) -> Self

Initializes a new, optional file configuration source.

Arguments

• path - The source file path

Trait Implementations

impl Clone for FileSource

fn clone(&self) -> FileSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<&FileSourceBuilder> for FileSource

fn from(value: &FileSourceBuilder) -> Self

Converts to this type from the input type.

impl From<&Path> for FileSource

fn from(value: &Path) -> Self

Converts to this type from the input type.

impl From<&PathBuf> for FileSource

fn from(value: &PathBuf) -> Self

Converts to this type from the input type.

impl From<&String> for FileSource

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for FileSource

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<FileSourceBuilder> for FileSource

fn from(value: FileSourceBuilder) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FileSource

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl From<String> for FileSource

fn from(value: String) -> Self

Converts to this type from the input type.