Struct Rules 

pub struct Rules {
    pub max_bytes: u64,
    pub content_types: &'static [&'static str],
}

Describes what a file field accepts: a size limit and a content-type allowlist.

Checked by Validator::file before anything is stored. A const, so the Multipart request limit can be computed from it (generated forms use the sum of their files’ limits plus 1 MB). The content type comes from the browser: the allowlist limits it, and Validator::file_content checks the bytes match it.

Examples

use ocre::storage::Rules;

const AVATAR: Rules = Rules { max_bytes: 5 * 1024 * 1024, content_types: &["image/png", "image/jpeg"] };
const FORM_LIMIT: usize = AVATAR.max_bytes as usize + 1024 * 1024;
assert_eq!(FORM_LIMIT, 6 * 1024 * 1024);
assert!(AVATAR.allows("image/PNG"));
assert!(!AVATAR.allows("image/svg+xml"));

Fields

max_bytes: u64

Largest accepted file, in bytes (u64: multipart uploads take files over 4 GB, more than a usize holds in WebAssembly). Request limits are usize: RULES.max_bytes as usize.

content_types: &'static [&'static str]

Accepted content types, exact and lowercase (image/png).

There is no wildcard: image/* would admit SVG, which can carry scripts.

Implementations

impl Rules

pub fn allows(&self, content_type: &str) -> bool

Returns whether content_type is in the allowlist, ignoring case and parameters.

Image/PNG; charset=binary is compared as image/png; an empty type counts as application/octet-stream. There is no wildcard matching.

Examples

use ocre::storage::Rules;

const DOC: Rules = Rules { max_bytes: 1024, content_types: &["application/pdf", "text/plain"] };
assert!(DOC.allows("text/plain; charset=utf-8"));
assert!(DOC.allows("Application/PDF"));
assert!(!DOC.allows("text/html"));
assert!(!DOC.allows(""));

Trait Implementations

impl Clone for Rules

fn clone(&self) -> Rules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rules

impl Debug for Rules

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

Formats the value using the given formatter.

impl Eq for Rules

impl PartialEq for Rules

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Rules