Struct Overlay 

pub struct Overlay<'a> {
    pub base: &'a Document,
    pub entities: BTreeMap<EntityId, Option<Entity>>,
    pub constraints: BTreeMap<ConstraintId, Option<Constraint>>,
    pub groups: BTreeMap<GroupId, Option<Group>>,
    pub layers: Option<Vec<Layer>>,
    pub settings: Option<Settings>,
    pub order_ops: Vec<OrderOp>,
    pub next_id: u64,
}

Copy-on-write overlay over a document used while a transaction runs.

Fields

base: &'a Document

Base document.

entities: BTreeMap<EntityId, Option<Entity>>

Changed entities (None = deleted).

constraints: BTreeMap<ConstraintId, Option<Constraint>>

Changed constraints.

groups: BTreeMap<GroupId, Option<Group>>

Changed groups.

layers: Option<Vec<Layer>>

Replaced layer list.

settings: Option<Settings>

Replaced settings.

order_ops: Vec<OrderOp>

Draw-order operations.

next_id: u64

ID allocator.

Implementations

impl<'a> Overlay<'a>

pub fn into_data(self) -> OverlayData

Detach the changes from the base document.

pub fn from_data(base: &'a Document, d: OverlayData) -> Self

Re-attach detached changes to the same base document.

impl<'a> Overlay<'a>

pub fn new(base: &'a Document) -> Self

Fresh overlay.

pub fn alloc_id(&mut self) -> u64

Allocate an ID.

pub fn entity_mut(&mut self, id: EntityId) -> Option<&mut Entity>

Entity for modification (copied into the overlay on first write).

pub fn put_entity(&mut self, e: Entity)

Insert or replace an entity.

pub fn delete_entity(&mut self, id: EntityId)

Delete an entity.

pub fn put_constraint(&mut self, c: Constraint)

Insert or replace a constraint.

pub fn delete_constraint(&mut self, id: ConstraintId)

Delete a constraint.

pub fn layers_mut(&mut self) -> &mut Vec<Layer>

Layers (copied on first write).

pub fn layers(&self) -> &[Layer]

Current layers.

pub fn settings_mut(&mut self) -> &mut Settings

Settings for modification.

pub fn constraint_ids(&self) -> Vec<ConstraintId>

All constraint IDs visible in the overlay (base ∪ new − deleted).

pub fn entity_ids(&self) -> Vec<EntityId>

All entity IDs visible in the overlay.

pub fn group_ids(&self) -> Vec<GroupId>

All groups visible in the overlay.

Trait Implementations

impl<'a> Clone for Overlay<'a>

fn clone(&self) -> Overlay<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Overlay<'a>

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

Formats the value using the given formatter.

impl DocView for Overlay<'_>

fn entity(&self, id: EntityId) -> Option<&Entity>

Entity by ID.

fn constraint(&self, id: ConstraintId) -> Option<&Constraint>

Constraint by ID.

fn layer(&self, id: LayerId) -> Option<&Layer>

Layer by ID.

fn group(&self, id: GroupId) -> Option<&Group>

Group by ID.

fn settings(&self) -> &Settings

Settings.