Struct Limits 

pub struct Limits {

    pub max_text_bytes: usize,
    pub max_definitions: usize,
    pub max_palette_colors: usize,
    pub max_sprite_side: u32,
    pub max_layers: usize,
    pub max_frames: usize,
    pub max_tiles: usize,
    pub max_map_side: u32,
    pub max_glyphs: usize,
    pub max_kerning_pairs: usize,
    pub max_export_files: usize,
    pub max_screen_items: usize,
    pub max_scene_commands: usize,
    pub max_scene_pixels: u64,
    pub max_scene_work: u64,
    pub max_scatter_attempts: u64,
    pub max_nesting: usize,
    pub max_image_side: u32,
    pub max_image_pixels: u64,
    pub max_warnings: usize,
}

Bounds on input and output, checked while text is parsed, before images are allocated and while PNG files are decoded.

The defaults suit hand-written files and untrusted input. Raise them for trusted input that needs more:

use spritebox::{Document, Limits};

let limits = Limits { max_sprite_side: 4096, ..Limits::default() };
let document = Document::parse_with("palette p\n  x #ff0000\n", &limits)?;

Fields

max_text_bytes: usize

Length of the text in bytes. Default 4 MiB.

max_definitions: usize

Number of top-level definitions: palettes, sprites and so on. Default 4096.

max_palette_colors: usize

Keys in one palette, inherited keys included. Default 256.

max_sprite_side: u32

Width or height of one sprite in pixels. Default 1024.

max_layers: usize

Layers in one sprite, layers of sprites used as layers included. Default 16.

max_frames: usize

Frames in one animation. Default 1024.

max_tiles: usize

Tiles in one tileset, terrain variants included. Default 4096.

max_map_side: u32

Width or height of one tilemap in tiles. Default 1024.

max_glyphs: usize

Glyphs in one font. Default 4096.

max_kerning_pairs: usize

Kerning pairs in one font. Default 4096.

max_export_files: usize

Files in an export, including theme variants. Default 8192.

max_screen_items: usize

Placements in one screen. Default 1024.

max_scene_commands: usize

Authored scene operations and list records. Default 4096.

max_scene_pixels: u64

Retained scene cells, profile entries, placements and operation images. Default 16 Mi.

max_scene_work: u64

Raster samples, edge tests, noise octaves and scatter work per operation. Default 64 Mi.

max_scatter_attempts: u64

Candidate attempts across all scatter groups in a document. Default 1,000,000.

max_nesting: usize

Depth of definitions built on other definitions: palettes copied from= another, and sprites derived from sprites. Default 32.

max_image_side: u32

Width or height of any image the crate creates or decodes, previews and atlases included. Default 8192.

max_image_pixels: u64

Pixels of any image the crate creates or decodes, and of all the sprites of a document together. Default 16 Mi (64 MiB of RGBA8).

max_warnings: usize

Warnings that Document::lint keeps; its counts include those left out. Default 1000.

Implementations

impl Limits

pub fn check_image(&self, width: u32, height: u32) -> Result<()>

Checks that an image of width × height pixels is within the image limits.

Trait Implementations

impl Clone for Limits

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Limits

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

Formats the value using the given formatter.

impl Default for Limits

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Limits

impl PartialEq for Limits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Limits