Skip to main content

CustomFormat

Struct CustomFormat 

Source
pub struct CustomFormat { /* private fields */ }
Expand description

A user-defined format: an id, the extensions it claims, and a parser callback. It goes into Options::formats like any built-in format (formats: [..the defaults, md.into()]), so the usual rule applies — the last claimer of an extension owns it, and a custom format can take over a built-in extension. Table-shaped custom formats can lower their file into rows and reuse the generic table stage via parse_table.

A markdown pipe-table as a config format (runs as a doc test — a string source can name a custom format directly, no files needed):

use c4::{CustomFormat, Loader};

let md = CustomFormat::new("md-table", ["md"], |text, path, options| {
    let rows: Vec<Vec<String>> = text
        .lines()
        .map(str::trim)
        .filter(|l| l.starts_with('|') && !l.contains("---"))
        // markdown tables always start with a header row — dropping
        // it here keeps the data rows positional (key,value[,format]),
        // exactly what parse_table expects
        .skip(1)
        .map(|l| {
            l.trim_matches('|')
                .split('|')
                .map(|cell| cell.trim().to_owned())
                .collect()
        })
        .collect();
    c4::parse_table(rows, &c4::TableLayout::Kv, path, options)
});

// to read `.md` files instead, push `md` into Options.formats —
// custom formats claim extensions exactly like built-ins do
let value: c4::Value = Loader::new(c4::Options {
        sources: vec![(
            md,
            "| key  | value | format |
             | ---- | ----- | ------ |
             | name | c4    | str    |
             | port | 8080  | u16    |",
        )
            .into()],
        ..c4::Options::default()
    })
    .load()?;
assert_eq!(value["name"].as_str(), Some("c4"));
assert_eq!(value["port"].as_u64(), Some(8080));

Implementations§

Source§

impl CustomFormat

Source

pub fn new<I, S, F>(id: impl Into<String>, extensions: I, parser: F) -> Self
where I: IntoIterator<Item = S>, S: Into<String>, F: Fn(&str, &Path, &Options) -> Result<Value> + Send + Sync + 'static,

Trait Implementations§

Source§

impl Clone for CustomFormat

Source§

fn clone(&self) -> CustomFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CustomFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<CustomFormat> for FormatKind

Source§

fn from(custom: CustomFormat) -> Self

Converts to this type from the input type.
Source§

impl From<CustomFormat> for FormatSpec

Source§

fn from(custom: CustomFormat) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for CustomFormat

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.