Skip to main content

StaticSpec

Enum StaticSpec 

Source
pub enum StaticSpec {
    Include(Vec<String>),
    Detailed(StaticConfig),
}
Expand description

Declares which non-JSON static files (images, CSS, …) found in the input data directory should be copied verbatim into each serializer destination.

Two shapes are accepted from configuration under the top-level $static key:

  • Shorthand (include only): "$static": ["*.png", "css/**"]
  • Full form: "$static": {"include": ["..."], "exclude": ["..."]}

§Priority

Copying is deny by default: without an include glob (or the --copy-static command line flag) nothing is copied. exclude (deny) always wins: a file that matches an exclude glob is never copied, even when copying is forced on for every file via --copy-static.

Variants§

§

Include(Vec<String>)

Shorthand form: a list of include (allow) globs.

§

Detailed(StaticConfig)

Full form with explicit include (allow) and exclude (deny) globs.

Implementations§

Source§

impl StaticSpec

Source

pub fn include(&self) -> &[String]

Returns the configured include (allow) glob patterns.

§Examples
use fauxrest::StaticSpec;

let spec = StaticSpec::Include(vec!["*.png".to_string()]);
assert_eq!(spec.include(), ["*.png".to_string()]);
Source

pub fn exclude(&self) -> &[String]

Returns the configured exclude (deny) glob patterns.

The shorthand StaticSpec::Include form has no deny globs, so it always returns an empty slice.

§Examples
use fauxrest::{StaticConfig, StaticSpec};

let spec = StaticSpec::Detailed(StaticConfig {
    include: vec!["**/*.css".to_string()],
    exclude: vec!["secret/**".to_string()],
});
assert_eq!(spec.exclude(), ["secret/**".to_string()]);

Trait Implementations§

Source§

impl Clone for StaticSpec

Source§

fn clone(&self) -> StaticSpec

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 StaticSpec

Source§

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

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

impl<'de> Deserialize<'de> for StaticSpec

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Dispatches on the JSON shape so a malformed form reports its own failure rather than a generic “did not match any variant”.

Source§

impl PartialEq for StaticSpec

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StaticSpec

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.