Struct DrawingStorage 

pub struct DrawingStorage {
    pub version: u32,
    pub symbol: String,
    pub timeframe: Option<String>,
    pub drawings: Vec<StoredDrawing>,
    pub metadata: StorageMetadata,
}

Drawing storage for saving/loading drawings

It is read only through Self::from_json, which checks the version, migrates older files and loads each drawing on its own.

Fields

version: u32

Format version, Self::CURRENT_VERSION once loaded

symbol: String

Symbol this storage is for

timeframe: Option<String>

Timeframe (optional)

drawings: Vec<StoredDrawing>

All stored drawings

metadata: StorageMetadata

Metadata

Implementations

impl DrawingStorage

pub const CURRENT_VERSION: u32 = 6

Current storage format version. Version 6 draws arrow marks in their own colour; earlier versions load in the colour they were drawn in. Version 5 gives Elliott double and triple combinations an unlabelled start point; earlier versions load with a start point on their first anchor. Version 4 draws brushes and highlighters at their stored width and opacity; earlier versions load at the width and opacity their strokes were drawn at. Version 3 preserves editable ray and extended-line extensions; versions 1 and 2 migrate to their former rendered reach when loaded.

pub fn new(symbol: impl Into<String>) -> Self

Create new storage for a symbol

pub fn with_timeframe(self, timeframe: impl Into<String>) -> Self

Set timeframe

pub fn add_drawing(&mut self, drawing: StoredDrawing)

Add a drawing, or replace the drawing with the same id in place, so a drawing saved again after an edit is stored once and the ids stay unique, as Self::from_json requires. The replacement keeps the position and the created_at of the drawing it replaces and takes every other field, notes included, from drawing.

pub fn remove_drawing(&mut self, id: &str) -> bool

Remove a drawing by ID

pub fn get_drawing(&self, id: &str) -> Option<&StoredDrawing>

Get a drawing by ID

pub fn get_drawing_mut(&mut self, id: &str) -> Option<&mut StoredDrawing>

Get a mutable drawing by ID

pub fn drawings(&self) -> &[StoredDrawing]

Get all drawings

pub fn to_json(&self) -> Result<String, SaveError>

Serialize to JSON, refusing what would lose a drawing on the next load: a non-finite number, which JSON cannot store and which would otherwise be written as null, an id an earlier drawing already has, a cursor tool such as the eraser, an unsupported timestamp and fewer anchors than the tool draws with. Self::from_json skips these records.

pub fn from_json(json: &str) -> Result<(Self, Vec<SkippedDrawing>), LoadError>

Deserialize from JSON, migrating versions 1 to 5 to the current format. Fails as a whole with a LoadError: LoadError::Json for invalid JSON or a missing or invalid version, symbol, timeframe or metadata, and LoadError::UnsupportedVersion for a version this release does not know. A drawing that cannot be read (a missing field, a null an earlier release wrote for a non-finite number, a number out of the range of its field, a tool type from a newer release, a cursor, fewer anchors than the tool draws with or a setting out of bounds) is left out and returned as a SkippedDrawing with its SkipReason, so one bad drawing does not lose the others. A drawing whose id an earlier loaded drawing already has is skipped too, so the loaded ids are unique and the first one in the file wins. Saving the returned storage writes only the drawings that loaded; keep the original file if the skipped ones must be recovered. A drawing whose timeframe filter names no timeframe loads as visible on every timeframe.

pub fn clear(&mut self)

Clear all drawings

Trait Implementations

impl Clone for DrawingStorage

fn clone(&self) -> DrawingStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DrawingStorage

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

Formats the value using the given formatter.

impl Serialize for DrawingStorage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.