Struct File 

pub struct File;

Loader for the file source: reads a single file or every file in a directory.

See the module docs for how names/formats are derived and how the ignore and lowercase options behave. Stateless — construct with File::new.

Example

use tanzim_load::{file::File, Load};
use tanzim_source::SourceBuilder;

// `ignore=[not-found]` turns a missing path into an empty result instead of an error,
// so this example is self-contained.
let source = SourceBuilder::new()
    .with_source("file")
    .with_resource("/path/to/config") // a file or a directory
    .with_option("ignore", vec!["not-found"])
    .build()
    .unwrap();

let payloads = File::new().load(source).unwrap();
assert!(payloads.is_empty()); // nothing at that path, and not-found is ignored

Implementations

impl File

pub fn new() -> Self

Create a filesystem loader. Configuration comes from the source’s options, not the type.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl Load for File

fn name(&self) -> &str

Human-readable name used in error messages.

fn supported_source_list(&self) -> Vec<String>

Source strings this loader handles (e.g. ["env"], ["file"], ["http", "https"]).

fn load(&self, source: Source) -> Result<Vec<Payload>, Error>

Load raw bytes from the source. Returns one Payload per config entry found.