Struct ProcessOptions 

#[non_exhaustive]
pub struct ProcessOptions {
    pub required_fields: Vec<String>,
    pub derive_slug: bool,
}

Options for process_metadata_with.

Example

use metadata_gen::metadata::{process_metadata_with, Metadata, ProcessOptions};
use std::collections::HashMap;

let opts = ProcessOptions::default().required_fields(["title"]);
let mut m = HashMap::new();
m.insert("title".to_string(), "Hello".to_string());
let out = process_metadata_with(&Metadata::new(m), &opts).unwrap();
assert_eq!(out.get("slug").map(String::as_str), Some("hello"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

required_fields: Vec<String>

Keys that must be present after processing. Default: title, date.

derive_slug: bool

Derive slug from title when absent. Default: true.

Implementations

impl ProcessOptions

pub fn required_fields<I, S>(self, fields: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the required-field list.

pub const fn derive_slug(self, on: bool) -> Self

Turns slug derivation on or off.

Trait Implementations

impl Clone for ProcessOptions

fn clone(&self) -> ProcessOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessOptions

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

Formats the value using the given formatter.

impl Default for ProcessOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ProcessOptions

impl PartialEq for ProcessOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProcessOptions